{
  "openapi": "3.0.0",
  "info": {
    "title": "BillHive",
    "version": "0.0.1",
    "description": "facades",
    "contact": {
      "name": "Mohit Aggarwal",
      "email": "mohitetc2008@gmail.com"
    }
  },
  "paths": {
    "/__coverage__": {
      "get": {
        "x-controller-name": "CoverageController",
        "x-operation-name": "getCoverage",
        "tags": [
          "CoverageController"
        ],
        "summary": "Retrieve code coverage data",
        "description": "Exposes Istanbul/NYC code coverage data collected during E2E tests. This endpoint is only active when the COVERAGE_MODE environment variable is set. Returns the global coverage object containing instrumentation data for all tested files.",
        "responses": {
          "200": {
            "description": "Istanbul coverage data object containing file coverage metrics",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Coverage mode not enabled"
          }
        },
        "operationId": "CoverageController.getCoverage"
      }
    },
    "/accounts/count": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "count",
        "tags": [
          "Analytics"
        ],
        "summary": "Count customer accounts",
        "description": "Returns the total count of customer accounts based on the provided filter criteria.",
        "responses": {
          "200": {
            "description": "Account count",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/loopback.Count"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "where",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "title": "Account.WhereFilter",
                  "additionalProperties": true,
                  "x-typescript-type": "@loopback/repository#Where<Account>"
                }
              }
            }
          }
        ],
        "operationId": "AnalyticsController.count"
      }
    },
    "/accounts/{accountId}/activity-logs": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "getAuditLog",
        "tags": [
          "Customer"
        ],
        "summary": "Fetch a customers audit log",
        "description": "Retrieves the audit log details of the desired customer. Information about a specific action or event related to a customer. Audit logs are often used to track and monitor activities performed on customer accounts or systems.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivityLog"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivityLog.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.getAuditLog"
      }
    },
    "/accounts/{id}/billing-address": {
      "post": {
        "x-controller-name": "AccountController",
        "x-operation-name": "addBillingAddress",
        "tags": [
          "Customer"
        ],
        "summary": "Create a customer",
        "description": "Creates a customer account with an optional sold-to contact. contactPerson represents sold-to contact.<br><br>The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewBillingAddress"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AccountController.addBillingAddress"
      }
    },
    "/accounts/{id}/billing-addresses": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "getBillingAddresses",
        "tags": [
          "Customer"
        ],
        "summary": "Fetch a customers audit log",
        "description": "Retrieves the audit log details of the desired customer. Information about a specific action or event related to a customer. Audit logs are often used to track and monitor activities performed on customer accounts or systems.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Address"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Address.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.getBillingAddresses"
      }
    },
    "/accounts/{accountId}/contacts/{id}": {
      "patch": {
        "x-controller-name": "AccountController",
        "x-operation-name": "updateContact",
        "tags": [
          "Customer"
        ],
        "summary": "Update contacts for a customer",
        "description": "Updates the details of a contact for a customer.",
        "responses": {
          "204": {
            "description": "Contact PATCH success"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "where",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "title": "Contact.WhereFilter",
                  "additionalProperties": true,
                  "x-typescript-type": "@loopback/repository#Where<Contact>"
                }
              }
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactPartial"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "AccountController.updateContact"
      },
      "delete": {
        "x-controller-name": "AccountController",
        "x-operation-name": "deleteContactId",
        "tags": [
          "Customer"
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Contact DELETE success"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AccountController.deleteContactId"
      }
    },
    "/accounts/{accountId}/contacts": {
      "post": {
        "x-controller-name": "AccountController",
        "x-operation-name": "createContact",
        "tags": [
          "Customer"
        ],
        "summary": "Add contacts to a customer",
        "description": "Adds the required contact to a customer. You can give the First Name, Last Name, Email ID and more details as input parameters to add them under the desired customer.",
        "responses": {
          "200": {
            "description": "Contact model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contact"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewContact"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AccountController.createContact"
      },
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findContacts",
        "tags": [
          "Customer"
        ],
        "summary": "List of contacts for a customers",
        "description": "This API retrieves all the contacts for a customer.",
        "responses": {
          "200": {
            "description": "Array of Contact model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ContactWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contact.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.findContacts"
      }
    },
    "/accounts/{accountId}/payment-methods/{id}": {
      "patch": {
        "x-controller-name": "AccountController",
        "x-operation-name": "updatePaymentMethodById",
        "tags": [
          "Customer"
        ],
        "summary": "Update payment method for a customer",
        "description": "Updates payment method details for a customer.",
        "responses": {
          "204": {
            "description": "PaymentMethod PATCH success"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentMethodPartial"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "AccountController.updatePaymentMethodById"
      },
      "delete": {
        "x-controller-name": "AccountController",
        "x-operation-name": "deletePaymentMethodById",
        "tags": [
          "Customer"
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "content": {
              "application/json": {
                "schema": {
                  "description": "PaymentMethod DELETE success"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AccountController.deletePaymentMethodById"
      }
    },
    "/accounts/{accountId}/payment-methods": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findPaymentMethods",
        "tags": [
          "Customer"
        ],
        "summary": "List payment methods for a customer",
        "description": "Get all payment method details for a customer.",
        "responses": {
          "200": {
            "description": "Array of PaymentMethod model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentMethodWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethod.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.findPaymentMethods"
      }
    },
    "/accounts/{id}": {
      "patch": {
        "x-controller-name": "AccountController",
        "x-operation-name": "updateById",
        "tags": [
          "Customer"
        ],
        "summary": "Update a customer",
        "description": "Updates the customer resource.",
        "responses": {
          "204": {
            "description": "Account PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountPartialExcluding_accountId_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AccountController.updateById"
      },
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findById",
        "tags": [
          "Customer"
        ],
        "summary": "Fetch a customer",
        "description": "Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.findById"
      },
      "delete": {
        "x-controller-name": "AccountController",
        "x-operation-name": "deleteById",
        "tags": [
          "Customer"
        ],
        "summary": "Delete a customer",
        "description": "Deletes a specific account asynchronously.",
        "responses": {
          "204": {
            "description": "Account PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AccountController.deleteById"
      }
    },
    "/accounts": {
      "post": {
        "x-controller-name": "AccountController",
        "x-operation-name": "create",
        "tags": [
          "Customer"
        ],
        "summary": "Create a customer",
        "description": "Creates a customer account with an optional sold-to contact. contactPerson represents sold-to contact.<br><br>The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewAccountInfo"
              }
            }
          }
        },
        "operationId": "AccountController.create"
      },
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "find",
        "tags": [
          "Customer"
        ],
        "summary": "List customers",
        "description": "Retrieves a list of customers added.",
        "responses": {
          "200": {
            "description": "Array of Account model instances",
            "content": {
              "application/json": {}
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "AccountController.find"
      }
    },
    "/activity-logs": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "queryActivityLogs",
        "tags": [
          "Customer"
        ],
        "summary": "Query activity logs",
        "description": "Retrieves the tenant's activity logs, newest first, filtered by subscription, account, entity, category, event type, severity, actor, correlation id or date range. subscriptionId returns everything related to the subscription (its invoices, payments, orders...).",
        "responses": {
          "200": {
            "description": "A page of activity logs and the total matching",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ActivityLog"
                      }
                    },
                    "total": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "accountId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "entityId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "eventType",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "severity",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "actorId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "correlationId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "operationId": "AccountController.queryActivityLogs"
      }
    },
    "/addon-features/{id}": {
      "patch": {
        "x-controller-name": "AddonFeatureController",
        "x-operation-name": "updateById",
        "tags": [
          "AddonFeature"
        ],
        "summary": "Update addon feature value",
        "description": "Updates the entitlement value for an addon-feature attachment.",
        "responses": {
          "204": {
            "description": "AddonFeature PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddonFeaturePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AddonFeatureController.updateById"
      },
      "get": {
        "x-controller-name": "AddonFeatureController",
        "x-operation-name": "findById",
        "tags": [
          "AddonFeature"
        ],
        "summary": "Fetch an addon feature",
        "description": "Retrieves a specific addon-feature attachment by ID.",
        "responses": {
          "200": {
            "description": "AddonFeature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonFeature"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonFeature.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AddonFeatureController.findById"
      },
      "delete": {
        "x-controller-name": "AddonFeatureController",
        "x-operation-name": "deleteById",
        "tags": [
          "AddonFeature"
        ],
        "summary": "Detach feature from addon",
        "description": "Removes a feature attachment from an addon.",
        "responses": {
          "204": {
            "description": "AddonFeature DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AddonFeatureController.deleteById"
      }
    },
    "/addon-features": {
      "post": {
        "x-controller-name": "AddonFeatureController",
        "x-operation-name": "create",
        "tags": [
          "AddonFeature"
        ],
        "summary": "Attach feature to addon",
        "description": "Attaches a feature to an addon with a specific value. This defines what entitlements the addon grants.",
        "responses": {
          "200": {
            "description": "AddonFeature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonFeature"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewAddonFeature"
              }
            }
          }
        },
        "operationId": "AddonFeatureController.create"
      },
      "get": {
        "x-controller-name": "AddonFeatureController",
        "x-operation-name": "find",
        "tags": [
          "AddonFeature"
        ],
        "summary": "List addon features",
        "description": "Retrieves all features attached to addons. Filter by addonId to get features for a specific addon.",
        "responses": {
          "200": {
            "description": "Array of AddonFeature model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AddonFeatureWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonFeature.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "AddonFeatureController.find"
      }
    },
    "/addon-prices/{id}/activate": {
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "activateAddonPrice",
        "tags": [
          "Addon"
        ],
        "summary": "Activate addon price",
        "description": "Activates an addon price, making it available for use in subscriptions.",
        "responses": {
          "204": {
            "description": "Addon price activated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AddonController.activateAddonPrice"
      }
    },
    "/addon-prices/{id}/deactivate": {
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "deactivateAddonPrice",
        "tags": [
          "Addon"
        ],
        "summary": "Deactivate addon price",
        "description": "Deactivates an addon price, making it unavailable for new subscriptions.",
        "responses": {
          "204": {
            "description": "Addon price deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AddonController.deactivateAddonPrice"
      }
    },
    "/addon-prices/{id}": {
      "patch": {
        "x-controller-name": "AddonController",
        "x-operation-name": "updatePriceById",
        "tags": [
          "Addon"
        ],
        "summary": "Update Addon Price instance based on key",
        "description": "Update Addon Price instance based on key. This key could be addon_price_key or id.",
        "responses": {
          "204": {
            "description": "Addon Price PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddonPricePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AddonController.updatePriceById"
      },
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "findPriceById",
        "tags": [
          "Addon"
        ],
        "summary": "Fetch an addon price",
        "description": "Retrieves the details of a specific addon price using either the addon price ID (UUID) or addon price key.",
        "responses": {
          "200": {
            "description": "AddonPrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPriceView"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Addon.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AddonController.findPriceById"
      }
    },
    "/addon-prices": {
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "findAllAddonPrices",
        "tags": [
          "Addon"
        ],
        "summary": "List all addon prices",
        "description": "Retrieves all addon prices across all addons. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of AddonPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPriceView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AddonController.findAllAddonPrices"
      }
    },
    "/addons/{id}/deactivate": {
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "deactivateAddon",
        "tags": [
          "Addon"
        ],
        "summary": "Deactivate addon",
        "description": "Deactivates an addon, making it unavailable for new subscriptions.",
        "responses": {
          "204": {
            "description": "Addon deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AddonController.deactivateAddon"
      }
    },
    "/addons/{id}/prices": {
      "post": {
        "x-controller-name": "AddonController",
        "x-operation-name": "createPrice",
        "tags": [
          "Addon"
        ],
        "summary": "Create addon price",
        "description": "Creates a new pricing tier for the specified addon. The price is created with DRAFT status.",
        "responses": {
          "200": {
            "description": "AddonPrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPrice"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewAddonPrice"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AddonController.createPrice"
      },
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "findAddonPrices",
        "tags": [
          "Addon"
        ],
        "summary": "List addon prices",
        "description": "Retrieves all pricing tiers for the specified addon. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of AddonPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddonPrice.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AddonController.findAddonPrices"
      }
    },
    "/addons/{id}": {
      "patch": {
        "x-controller-name": "AddonController",
        "x-operation-name": "updateById",
        "tags": [
          "Addon"
        ],
        "summary": "Update an addon",
        "description": "Updates an addon using either the addon ID (UUID) or addon key. Allows partial updates of addon properties.",
        "responses": {
          "204": {
            "description": "Addon PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddonPartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AddonController.updateById"
      },
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "findById",
        "tags": [
          "Addon"
        ],
        "summary": "Fetch an addon",
        "description": "Retrieves the details of a specific addon using either the addon ID (UUID) or addon key. Supports filtering and field selection.",
        "responses": {
          "200": {
            "description": "Addon model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Addon"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Addon.Filter"
                }
              }
            }
          }
        ],
        "operationId": "AddonController.findById"
      },
      "delete": {
        "x-controller-name": "AddonController",
        "x-operation-name": "deleteById",
        "tags": [
          "Addon"
        ],
        "summary": "Delete an addon",
        "description": "Deletes a specific addon. This operation is asynchronous.",
        "responses": {
          "204": {
            "description": "Addon DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AddonController.deleteById"
      }
    },
    "/addons": {
      "post": {
        "x-controller-name": "AddonController",
        "x-operation-name": "create",
        "tags": [
          "Addon"
        ],
        "summary": "Create an addon",
        "description": "Creates a new addon with DRAFT status. Addons can be added to subscriptions to provide additional features or services.",
        "responses": {
          "200": {
            "description": "Addon model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Addon"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewAddon"
              }
            }
          }
        },
        "operationId": "AddonController.create"
      },
      "get": {
        "x-controller-name": "AddonController",
        "x-operation-name": "find",
        "tags": [
          "Addon"
        ],
        "summary": "List addons",
        "description": "Retrieves a list of all addons for the current tenant. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of Addon model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AddonsWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Addon.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "AddonController.find"
      }
    },
    "/analytics/arr": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "annualRecurringRevenue",
        "tags": [
          "Analytics"
        ],
        "summary": "Get annual recurring revenue",
        "description": "Calculates the Annual Recurring Revenue (ARR) based on active subscriptions and their recurring charges.",
        "responses": {
          "200": {
            "description": "AnnualRecurringRevenue model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AnnualRecurringRevenue"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.annualRecurringRevenue"
      }
    },
    "/analytics/dunning": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "dunningAnalytics",
        "tags": [
          "Analytics"
        ],
        "summary": "Get dunning & recovery analytics",
        "description": "Retrieves dunning analytics including recovery rates, retry success by attempt, breakdowns by gateway and failure reason.",
        "responses": {
          "200": {
            "description": "Dunning analytics data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.dunningAnalytics"
      }
    },
    "/analytics/payment-success-rate": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "paymentSuccessRate",
        "tags": [
          "Analytics"
        ],
        "summary": "Get payment success rate",
        "description": "Calculates the payment success rate, showing the percentage of successful payments vs failed payment attempts.",
        "responses": {
          "200": {
            "description": "PaymentSuccessRate model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentSuccessRate"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.paymentSuccessRate"
      }
    },
    "/analytics/rate-plan-subscriptions": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "ratePlanSubscriptionsSummary",
        "tags": [
          "Analytics"
        ],
        "summary": "Get rate plan subscription distribution",
        "description": "Retrieves the distribution of subscriptions across different rate plans.",
        "responses": {
          "200": {
            "description": "Rate plan subscription distribution",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.ratePlanSubscriptionsSummary"
      }
    },
    "/analytics/subscription-change": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "newVsCancelledSubscriptions",
        "tags": [
          "Analytics"
        ],
        "summary": "Get subscription change analytics",
        "description": "Compares new subscriptions vs cancelled subscriptions to track growth trends over time.",
        "responses": {
          "200": {
            "description": "NewVsCancelledSubscriptions model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NewVsCancelledSubscriptions"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.newVsCancelledSubscriptions"
      }
    },
    "/analytics/subscription-renewal-rate": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "subscriptionRenewalRate",
        "tags": [
          "Analytics"
        ],
        "summary": "Get subscription renewal rate",
        "description": "Calculates the subscription renewal rate, showing the percentage of subscriptions that are renewed vs churned.",
        "responses": {
          "200": {
            "description": "SubscriptionRenewalRate model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionRenewalRate"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.subscriptionRenewalRate"
      }
    },
    "/analytics/subscription-status-breakdown": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "subscriptionStatusBreakdown",
        "tags": [
          "Analytics"
        ],
        "summary": "Get subscription status breakdown",
        "description": "Retrieves a breakdown of subscriptions by status (active, pending, cancelled, expired, etc.).",
        "responses": {
          "200": {
            "description": "SubscriptionStatusBreakdown model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionStatusBreakdown"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.subscriptionStatusBreakdown"
      }
    },
    "/analytics/top5-rate-plans": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "top5RatePlans",
        "tags": [
          "Analytics"
        ],
        "summary": "Get top 5 rate plans",
        "description": "Retrieves the top 5 most popular rate plans based on subscription count over the last 6 months.",
        "responses": {
          "200": {
            "description": "Array of monthly rate plan statistics",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.top5RatePlans"
      }
    },
    "/analytics/trial-conversion-rate": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "trialConversionRate",
        "tags": [
          "Analytics"
        ],
        "summary": "Get trial conversion rate analytics",
        "description": "Retrieves trial conversion rate metrics including overall summary, monthly breakdown, plan-level breakdown, and conversion funnel data.",
        "responses": {
          "200": {
            "description": "Trial conversion rate analytics data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "operationId": "AnalyticsController.trialConversionRate"
      }
    },
    "/api-keys/permissions": {
      "get": {
        "x-controller-name": "ApiKeyController",
        "x-operation-name": "findPermissions",
        "tags": [
          "API-Key"
        ],
        "summary": "List API key permissions",
        "description": "Retrieves a list of all available permissions that can be assigned to API keys.",
        "responses": {
          "200": {
            "description": "Array of Permission model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PermissionsWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Permission.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ApiKeyController.findPermissions"
      }
    },
    "/api-keys/{id}/refresh": {
      "get": {
        "x-controller-name": "ApiKeyController",
        "x-operation-name": "refreshApikey",
        "tags": [
          "API-Key"
        ],
        "summary": "Refresh API key",
        "description": "Generates a new API key value for the specified API key while maintaining its permissions and configuration.",
        "responses": {
          "200": {
            "description": "ApiKey model instance with new key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ApiKeyController.refreshApikey"
      }
    },
    "/api-keys/{id}": {
      "delete": {
        "x-controller-name": "ApiKeyController",
        "x-operation-name": "deleteById",
        "tags": [
          "API-Key"
        ],
        "summary": "Delete an API key",
        "description": "Permanently deletes the specified API key. This action cannot be undone.",
        "responses": {
          "204": {
            "description": "API Key DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ApiKeyController.deleteById"
      }
    },
    "/api-keys": {
      "post": {
        "x-controller-name": "ApiKeyController",
        "x-operation-name": "create",
        "tags": [
          "API-Key"
        ],
        "summary": "Create an API key",
        "description": "Creates a new API key with specified permissions for programmatic access to the API.",
        "responses": {
          "200": {
            "description": "ApiKey model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewApiKey"
              }
            }
          }
        },
        "operationId": "ApiKeyController.create"
      },
      "get": {
        "x-controller-name": "ApiKeyController",
        "x-operation-name": "find",
        "tags": [
          "API-Key"
        ],
        "summary": "List API keys",
        "description": "Retrieves a list of all API keys for the current tenant. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of ApiKey model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeysWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ApiKeyController.find"
      }
    },
    "/applicable-offers": {
      "post": {
        "x-controller-name": "OfferController",
        "x-operation-name": "findApplicableOffers",
        "tags": [
          "Offer"
        ],
        "summary": "Find applicable offers",
        "description": "Retrieves offers applicable to a given rate plan price, addon price, or charge price.",
        "responses": {
          "200": {
            "description": "Array of OfferApplicability model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OfferApplicabilityWithRelations"
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewOfferApplicability1"
              }
            }
          }
        },
        "operationId": "OfferController.findApplicableOffers"
      }
    },
    "/apply-transactions/{transactionId}": {
      "get": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "findById",
        "tags": [
          "Transaction"
        ],
        "summary": "Fetch applied transactions",
        "description": "Retrieves all applied transaction records for a specific transaction. Applied transactions show how a payment has been allocated to invoices or account balances.",
        "responses": {
          "200": {
            "description": "ApplyTransaction model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplyTransactionWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplyTransaction.Filter"
                }
              }
            }
          }
        ],
        "operationId": "TransactionController.findById"
      }
    },
    "/apply-transactions": {
      "post": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "createApplyTransaction",
        "tags": [
          "Transaction"
        ],
        "summary": "Apply transactions to invoices",
        "description": "Applies a transaction amount to one or more invoices or account balances. This operation updates invoice balances and tracks the allocation of payment amounts.",
        "responses": {
          "200": {
            "description": "ApplyTransaction model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplyTransactionWithRelations"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NewApplyTransaction"
                }
              }
            }
          }
        },
        "operationId": "TransactionController.createApplyTransaction"
      }
    },
    "/billing-periods/{id}": {
      "patch": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "updateBillingPeriodById",
        "tags": [
          "Billing Period"
        ],
        "summary": "Update billing period",
        "description": "Updates the specified billing period configuration.",
        "responses": {
          "204": {
            "description": "Period PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PeriodPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "BillingPeriodController.updateBillingPeriodById"
      }
    },
    "/billing-periods": {
      "post": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "createBillingPeriod",
        "tags": [
          "Billing Period"
        ],
        "summary": "Create billing period",
        "description": "Creates a new billing period option for use in rate plans and subscriptions.",
        "responses": {
          "200": {
            "description": "Period model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPeriod"
              }
            }
          }
        },
        "operationId": "BillingPeriodController.createBillingPeriod"
      },
      "get": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "findBillingPeriodOptions",
        "tags": [
          "Billing Period"
        ],
        "summary": "List billing periods",
        "description": "Retrieves a list of billing period options available for subscriptions. Excludes trial periods.",
        "responses": {
          "200": {
            "description": "Array of Period model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Period"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period.Filter"
                }
              }
            }
          }
        ],
        "operationId": "BillingPeriodController.findBillingPeriodOptions"
      }
    },
    "/billing-strategies/{id}": {
      "patch": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "updateBillingStrategyById",
        "tags": [
          "Billing Period"
        ],
        "summary": "Update billing strategy",
        "description": "Updates the specified billing strategy configuration.",
        "responses": {
          "204": {
            "description": "Billing strategy PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PeriodPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "BillingPeriodController.updateBillingStrategyById"
      },
      "delete": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "deleteBillingStrategyById",
        "tags": [
          "Billing Period"
        ],
        "summary": "Delete billing strategy",
        "description": "Deletes the specified billing strategy.",
        "responses": {
          "204": {
            "description": "Billing strategy DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "BillingPeriodController.deleteBillingStrategyById"
      }
    },
    "/billing-strategies": {
      "post": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "createBillingStrategy",
        "tags": [
          "Billing Period"
        ],
        "summary": "Create billing strategy",
        "description": "Creates a new billing strategy (a period row with a specific term length representing a pricing point).",
        "responses": {
          "200": {
            "description": "Period model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewBillingStrategy"
              }
            }
          }
        },
        "operationId": "BillingPeriodController.createBillingStrategy"
      },
      "get": {
        "x-controller-name": "BillingPeriodController",
        "x-operation-name": "findBillingStrategies",
        "tags": [
          "Billing Period"
        ],
        "summary": "List billing strategies",
        "description": "Retrieves billing strategies (combinations of billing frequency + term length). Strategies with termLength > 1 represent commitment-based pricing points.",
        "responses": {
          "200": {
            "description": "Array of Period model instances representing billing strategies",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Period"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period.Filter"
                }
              }
            }
          }
        ],
        "operationId": "BillingPeriodController.findBillingStrategies"
      }
    },
    "/business-profile": {
      "put": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "upsertBusinessProfile",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Save the tenant business profile",
        "description": "Creates or updates the non-sensitive business profile used to create payment gateway merchant accounts. PAN, bank account and KYC documents are not accepted here.",
        "responses": {
          "200": {
            "description": "Tenant business profile saved",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantBusinessProfile"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TenantBusinessProfileInput"
              }
            }
          }
        },
        "operationId": "PaymentGatewayOnboardingController.upsertBusinessProfile"
      },
      "get": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "getBusinessProfile",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Get the tenant business profile",
        "description": "Returns the business details reused for every payment gateway the tenant onboards with. Contains no KYC data.",
        "responses": {
          "200": {
            "description": "Tenant business profile",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantBusinessProfile"
                }
              }
            }
          }
        },
        "operationId": "PaymentGatewayOnboardingController.getBusinessProfile"
      }
    },
    "/calculate-cost-to-pay-now": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "calculateCost",
        "tags": [
          "Subscription"
        ],
        "summary": "Calculate subscription cost",
        "description": "Calculates the cost for a subscription based on the provided rate plan, addons, and other parameters. This is used to preview costs before creating or modifying a subscription.",
        "responses": {
          "200": {
            "description": "Calculated cost details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalculateCostResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/calculateCost"
              }
            }
          }
        },
        "operationId": "SubscriptionController.calculateCost"
      }
    },
    "/charge-prices/{id}/activate": {
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "activateChargePrice",
        "tags": [
          "Charge"
        ],
        "summary": "Activate charge price",
        "description": "Activates a charge price, making it available for use in subscriptions.",
        "responses": {
          "204": {
            "description": "Charge price activated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ChargeController.activateChargePrice"
      }
    },
    "/charge-prices/{id}/deactivate": {
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "deactivateChargePrice",
        "tags": [
          "Charge"
        ],
        "summary": "Deactivate charge price",
        "description": "Deactivates a charge price, making it unavailable for new subscriptions.",
        "responses": {
          "204": {
            "description": "Charge price deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ChargeController.deactivateChargePrice"
      }
    },
    "/charge-prices/{id}": {
      "patch": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "updatePriceById",
        "tags": [
          "Charge"
        ],
        "summary": "Update Charge Price instance based on key",
        "description": "Update Charge Price instance based on key. This key could be charge_price_key or id.",
        "responses": {
          "204": {
            "description": "Charge Price PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChargePricePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ChargeController.updatePriceById"
      },
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "findPriceById",
        "tags": [
          "Charge"
        ],
        "summary": "Fetch a charge price",
        "description": "Retrieves the details of a specific charge price using either the charge price ID (UUID) or charge price key.",
        "responses": {
          "200": {
            "description": "ChargePrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargePriceView"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ChargeController.findPriceById"
      }
    },
    "/charge-prices": {
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "findPrices",
        "tags": [
          "Charge"
        ],
        "summary": "List all charge prices",
        "description": "Retrieves all charge prices across all charges. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of ChargePrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargePrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "ChargeController.findPrices"
      }
    },
    "/charges/{id}/deactivate": {
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "deactivateCharge",
        "tags": [
          "Charge"
        ],
        "summary": "Deactivate charge",
        "description": "Deactivates a charge, making it unavailable for new subscriptions.",
        "responses": {
          "204": {
            "description": "Charge deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ChargeController.deactivateCharge"
      }
    },
    "/charges/{id}/prices": {
      "post": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "createPrice",
        "tags": [
          "Charge"
        ],
        "summary": "Create charge price",
        "description": "Creates a new pricing tier for the specified charge. The price is created with DRAFT status.",
        "responses": {
          "200": {
            "description": "ChargePrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargePrice"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewChargePrice"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ChargeController.createPrice"
      },
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "findChargePrices",
        "tags": [
          "Charge"
        ],
        "summary": "List charge prices",
        "description": "Retrieves all pricing tiers for the specified charge. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of ChargePrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargePrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargePrice.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ChargeController.findChargePrices"
      }
    },
    "/charges/{id}": {
      "patch": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "updateById",
        "tags": [
          "Charge"
        ],
        "summary": "Update a charge",
        "description": "Updates a charge using either the charge ID (UUID) or charge key. Allows partial updates of charge properties.",
        "responses": {
          "204": {
            "description": "Charge PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChargePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ChargeController.updateById"
      },
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "findById",
        "tags": [
          "Charge"
        ],
        "summary": "Fetch a charge",
        "description": "Retrieves the details of a specific charge using either the charge ID (UUID) or charge key.",
        "responses": {
          "200": {
            "description": "Charge model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ChargeController.findById"
      },
      "delete": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "deleteById",
        "tags": [
          "Charge"
        ],
        "summary": "Delete a charge",
        "description": "Deletes a specific charge. This operation is asynchronous.",
        "responses": {
          "204": {
            "description": "Charge DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ChargeController.deleteById"
      }
    },
    "/charges": {
      "post": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "create",
        "tags": [
          "Charge"
        ],
        "summary": "Create a charge",
        "description": "Creates a new charge with DRAFT status. Charges represent one-time or recurring fees that can be added to subscriptions.",
        "responses": {
          "200": {
            "description": "Charge model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewCharge"
              }
            }
          }
        },
        "operationId": "ChargeController.create"
      },
      "get": {
        "x-controller-name": "ChargeController",
        "x-operation-name": "find",
        "tags": [
          "Charge"
        ],
        "summary": "List charges",
        "description": "Retrieves a list of all charges for the current tenant. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of Charge model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ChargesWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Charge.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "ChargeController.find"
      }
    },
    "/coupon-sets/auto-generate": {
      "post": {
        "x-controller-name": "CouponSetController",
        "x-operation-name": "autoGenerate",
        "tags": [
          "CouponSet"
        ],
        "summary": "Auto-generate coupon sets",
        "description": "Generates a specified number of coupon codes with optional prefix and suffix.",
        "responses": {
          "200": {
            "description": "Array of auto-generated CouponSet instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CouponSet"
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "numberOfCoupons",
                  "couponSetName",
                  "couponId"
                ],
                "properties": {
                  "numberOfCoupons": {
                    "type": "number"
                  },
                  "prefix": {
                    "type": "string"
                  },
                  "suffix": {
                    "type": "string"
                  },
                  "couponSetName": {
                    "type": "string"
                  },
                  "couponId": {
                    "type": "string"
                  },
                  "tenantId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "operationId": "CouponSetController.autoGenerate"
      }
    },
    "/coupon-sets/bulk": {
      "post": {
        "x-controller-name": "CouponSetController",
        "x-operation-name": "bulkCreate",
        "tags": [
          "CouponSet"
        ],
        "summary": "Bulk create coupon sets from CSV upload",
        "description": "Creates multiple coupon set entries in bulk, typically from a CSV file upload.",
        "responses": {
          "200": {
            "description": "Array of created CouponSet instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CouponSet"
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NewCouponSetBulk"
                }
              }
            }
          }
        },
        "operationId": "CouponSetController.bulkCreate"
      }
    },
    "/coupon-sets/{id}": {
      "get": {
        "x-controller-name": "CouponSetController",
        "x-operation-name": "findById",
        "tags": [
          "CouponSet"
        ],
        "summary": "Fetch a coupon set",
        "description": "Retrieves a specific coupon set by its ID.",
        "responses": {
          "200": {
            "description": "CouponSet model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponSetWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "CouponSetController.findById"
      },
      "delete": {
        "x-controller-name": "CouponSetController",
        "x-operation-name": "deleteById",
        "tags": [
          "CouponSet"
        ],
        "summary": "Delete a coupon set",
        "description": "Deletes a specific coupon set by its ID.",
        "responses": {
          "204": {
            "description": "CouponSet DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "CouponSetController.deleteById"
      }
    },
    "/coupon-sets": {
      "get": {
        "x-controller-name": "CouponSetController",
        "x-operation-name": "find",
        "tags": [
          "CouponSet"
        ],
        "summary": "List coupon sets",
        "description": "Retrieves a list of all coupon sets for the current tenant.",
        "responses": {
          "200": {
            "description": "Array of CouponSet model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CouponSetWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CouponSet.Filter"
                }
              }
            }
          }
        ],
        "operationId": "CouponSetController.find"
      }
    },
    "/credit-memos/{id}/download": {
      "get": {
        "x-controller-name": "MemoController",
        "x-operation-name": "downloadCreditNote",
        "tags": [
          "MemoController"
        ],
        "summary": "Download credit note PDF",
        "description": "Renders the GST credit note for a credit memo as a PDF titled \"Credit Note\": credit note number and date, the original invoice, both parties' GSTINs, line items and the CGST/SGST/IGST split.",
        "responses": {
          "200": {
            "description": "Credit note PDF file",
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "MemoController.downloadCreditNote"
      }
    },
    "/credit-memos": {
      "post": {
        "x-controller-name": "MemoController",
        "x-operation-name": "createCreditMemo",
        "tags": [
          "MemoController"
        ],
        "summary": "Create a credit memo",
        "description": "Creates a new credit memo for a customer account. Credit memos represent credits issued to customers for various reasons such as refunds, billing adjustments, overpayments, or service credits. The memo can be associated with a specific subscription or order, and tracks the amount, currency, reason, effective date, and status.",
        "responses": {
          "200": {
            "description": "CreditMemo model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditMemo"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewCreditMemo"
              }
            }
          }
        },
        "operationId": "MemoController.createCreditMemo"
      }
    },
    "/currencies": {
      "post": {
        "x-controller-name": "CurrencyController",
        "x-operation-name": "create",
        "tags": [
          "Currency"
        ],
        "summary": "Add a currency to tenant",
        "description": "Adds a new currency to the tenant configuration. The first currency added automatically becomes the base currency for the tenant. For subsequent currencies, the system calculates conversion rates relative to the base currency using current exchange rates. The currency must exist in the master currency catalog.",
        "responses": {
          "200": {
            "description": "CurrencyReq model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyReq"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewCurrency"
              }
            }
          }
        },
        "operationId": "CurrencyController.create"
      },
      "get": {
        "x-controller-name": "CurrencyController",
        "x-operation-name": "findCurrencies",
        "tags": [
          "Currency"
        ],
        "summary": "List tenant currencies",
        "description": "Retrieves a list of all currencies configured for the current tenant. Returns all currency configurations including base currency, conversion rates, and currency codes.",
        "responses": {
          "200": {
            "description": "Array of TenantCurrency model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "operationId": "CurrencyController.findCurrencies"
      }
    },
    "/debit-memos": {
      "post": {
        "x-controller-name": "MemoController",
        "x-operation-name": "createDebitMemo",
        "tags": [
          "MemoController"
        ],
        "summary": "Create a debit memo",
        "description": "Creates a new debit memo for a customer account. Debit memos represent billing adjustments that increase a customer's balance — e.g. usage overages, late fees, service charges, plan upgrades, add-on charges, tax adjustments, underpayments, or manual adjustments.",
        "responses": {
          "200": {
            "description": "DebitMemo model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DebitMemo"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewDebitMemo"
              }
            }
          }
        },
        "operationId": "MemoController.createDebitMemo"
      }
    },
    "/download/{filename}": {
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "downloadFile",
        "tags": [
          "Invoice"
        ],
        "responses": {
          "200": {
            "description": "Return value of InvoiceController.downloadFile"
          }
        },
        "parameters": [
          {
            "name": "filename",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.downloadFile"
      }
    },
    "/dunning-actions/{id}": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findDunningActionById",
        "tags": [
          "Customer"
        ],
        "summary": "Get dunning action by ID",
        "responses": {
          "200": {
            "description": "DunningAction model instance"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AccountController.findDunningActionById"
      }
    },
    "/dunning-actions": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findDunningActions",
        "tags": [
          "Customer"
        ],
        "summary": "List dunning actions",
        "responses": {
          "200": {
            "description": "Array of DunningAction model instances"
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "AccountController.findDunningActions"
      }
    },
    "/dunning-cases/count": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "countDunningCases",
        "tags": [
          "Customer"
        ],
        "summary": "Count dunning cases",
        "responses": {
          "200": {
            "description": "DunningCase count"
          }
        },
        "parameters": [
          {
            "name": "where",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "AccountController.countDunningCases"
      }
    },
    "/dunning-cases/{id}": {
      "patch": {
        "x-controller-name": "AccountController",
        "x-operation-name": "updateDunningCaseById",
        "tags": [
          "Customer"
        ],
        "summary": "Update dunning case by ID",
        "responses": {
          "200": {
            "description": "DunningCase PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "AccountController.updateDunningCaseById"
      },
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findDunningCaseById",
        "tags": [
          "Customer"
        ],
        "summary": "Get dunning case by ID",
        "responses": {
          "200": {
            "description": "DunningCase model instance"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AccountController.findDunningCaseById"
      }
    },
    "/dunning-cases": {
      "get": {
        "x-controller-name": "AccountController",
        "x-operation-name": "findDunningCases",
        "tags": [
          "Customer"
        ],
        "summary": "List dunning cases",
        "responses": {
          "200": {
            "description": "Array of DunningCase model instances"
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "AccountController.findDunningCases"
      }
    },
    "/email-preferences/{id}": {
      "patch": {
        "x-controller-name": "NotificationController",
        "x-operation-name": "updateEmailPreferenceById",
        "tags": [
          "Notification"
        ],
        "summary": "Update email preference",
        "description": "Updates the settings for a specific email preference type. Use this to enable/disable specific notification email types or modify their configuration settings.",
        "responses": {
          "204": {
            "description": "EmailPreference PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EmailPreferencePartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "NotificationController.updateEmailPreferenceById"
      }
    },
    "/email-preferences": {
      "get": {
        "x-controller-name": "NotificationController",
        "x-operation-name": "findAllEmailTypes",
        "tags": [
          "Notification"
        ],
        "summary": "List email preferences",
        "description": "Retrieves a list of all email preference types configured in the system. Email preferences allow users to customize which notification emails they receive and their delivery settings.",
        "responses": {
          "200": {
            "description": "Array of EmailPreference model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EmailPreferenceWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmailPreference.Filter"
                }
              }
            }
          }
        ],
        "operationId": "NotificationController.findAllEmailTypes"
      }
    },
    "/features/{id}/activate": {
      "get": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "activate",
        "tags": [
          "Feature"
        ],
        "summary": "Activate a feature",
        "description": "Activates a feature, making it available for use.",
        "responses": {
          "204": {
            "description": "Feature activated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "FeatureController.activate"
      }
    },
    "/features/{id}/deactivate": {
      "get": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "deactivate",
        "tags": [
          "Feature"
        ],
        "summary": "Deactivate a feature",
        "description": "Deactivates a feature, making it unavailable.",
        "responses": {
          "204": {
            "description": "Feature deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "FeatureController.deactivate"
      }
    },
    "/features/{id}": {
      "patch": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "updateById",
        "tags": [
          "Feature"
        ],
        "summary": "Update a feature",
        "description": "Updates a feature using either the feature ID (UUID) or feature key. Allows partial updates.",
        "responses": {
          "204": {
            "description": "Feature PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FeaturePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "FeatureController.updateById"
      },
      "get": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "findById",
        "tags": [
          "Feature"
        ],
        "summary": "Fetch a feature",
        "description": "Retrieves the details of a specific feature using either the feature ID (UUID) or feature key.",
        "responses": {
          "200": {
            "description": "Feature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Feature"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Feature.Filter"
                }
              }
            }
          }
        ],
        "operationId": "FeatureController.findById"
      },
      "delete": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "deleteById",
        "tags": [
          "Feature"
        ],
        "summary": "Delete a feature",
        "description": "Deletes a specific feature.",
        "responses": {
          "204": {
            "description": "Feature DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "FeatureController.deleteById"
      }
    },
    "/features": {
      "post": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "create",
        "tags": [
          "Feature"
        ],
        "summary": "Create a feature",
        "description": "Creates a new feature with DRAFT status. Features define capabilities that can be attached to rate plans and addons.",
        "responses": {
          "200": {
            "description": "Feature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Feature"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewFeature"
              }
            }
          }
        },
        "operationId": "FeatureController.create"
      },
      "get": {
        "x-controller-name": "FeatureController",
        "x-operation-name": "find",
        "tags": [
          "Feature"
        ],
        "summary": "List features",
        "description": "Retrieves a list of all features for the current tenant. Supports filtering, sorting, and pagination.",
        "responses": {
          "200": {
            "description": "Array of Feature model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/FeaturesWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Feature.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "FeatureController.find"
      }
    },
    "/forget-password": {
      "post": {
        "x-controller-name": "AuthController",
        "x-operation-name": "forgetPassword",
        "tags": [
          "Auth"
        ],
        "summary": "Forgot password",
        "description": "Emails a reset-password link (valid 15 minutes) if the address belongs to a user. The response is the same whether or not it does.",
        "responses": {
          "204": {
            "description": "Request accepted"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ForgetPassword"
              }
            }
          }
        },
        "operationId": "AuthController.forgetPassword"
      }
    },
    "/in-app-notifications/read-all": {
      "post": {
        "x-controller-name": "InAppNotificationController",
        "x-operation-name": "markAllAsRead",
        "tags": [
          "InAppNotification"
        ],
        "summary": "Mark all notifications as read",
        "description": "Marks all in-app notifications as read for the current user based on their roles.",
        "responses": {
          "200": {
            "description": "Success response with count of marked notifications"
          }
        },
        "operationId": "InAppNotificationController.markAllAsRead"
      }
    },
    "/in-app-notifications/unread-count": {
      "get": {
        "x-controller-name": "InAppNotificationController",
        "x-operation-name": "getUnreadCount",
        "tags": [
          "InAppNotification"
        ],
        "summary": "Get unread notification count",
        "description": "Returns the count of unread in-app notifications for the current user, used for the bell icon badge.",
        "responses": {
          "200": {
            "description": "Unread count object"
          }
        },
        "operationId": "InAppNotificationController.getUnreadCount"
      }
    },
    "/in-app-notifications/{id}/read": {
      "post": {
        "x-controller-name": "InAppNotificationController",
        "x-operation-name": "markAsRead",
        "tags": [
          "InAppNotification"
        ],
        "summary": "Mark notification as read",
        "description": "Marks a single in-app notification as read for the current user.",
        "responses": {
          "200": {
            "description": "Success response"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InAppNotificationController.markAsRead"
      }
    },
    "/in-app-notifications": {
      "get": {
        "x-controller-name": "InAppNotificationController",
        "x-operation-name": "find",
        "tags": [
          "InAppNotification"
        ],
        "summary": "List in-app notifications",
        "description": "Retrieves in-app notifications for the current user based on their roles. Returns notifications with read/unread status.",
        "responses": {
          "200": {
            "description": "Array of in-app notifications"
          }
        },
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "number"
            }
          }
        ],
        "operationId": "InAppNotificationController.find"
      }
    },
    "/invoices/{invoiceId}/download": {
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "downloadByInvoiceId",
        "tags": [
          "Invoice"
        ],
        "summary": "Download invoice PDF",
        "description": "Downloads the invoice as a PDF file. This endpoint retrieves the generated invoice document from storage and returns it for download.",
        "responses": {
          "200": {
            "description": "Invoice PDF file",
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.downloadByInvoiceId"
      }
    },
    "/invoices/{invoiceId}/invoice-items": {
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "findByInvoiceId",
        "tags": [
          "Invoice"
        ],
        "summary": "List invoice items",
        "description": "Retrieves all line items associated with a specific invoice. Each line item represents a charge or credit on the invoice.",
        "responses": {
          "200": {
            "description": "Array of Invoice Item model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/InvoiceItemWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.findByInvoiceId"
      }
    },
    "/invoices/{invoiceId}": {
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "findById",
        "tags": [
          "Invoice"
        ],
        "summary": "Fetch an invoice",
        "description": "Retrieves the details of a specific invoice. You can use the unique identifier for a particular invoice to retrieve the desired details including invoice items, amounts, and status.",
        "responses": {
          "200": {
            "description": "Invoice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.findById"
      }
    },
    "/invoices/{id}": {
      "delete": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "deleteById",
        "tags": [
          "Invoice"
        ],
        "summary": "Delete an invoice",
        "description": "Deletes a specific invoice. This operation permanently removes the invoice and its associated data from the system.",
        "responses": {
          "204": {
            "description": "Invoice DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.deleteById"
      }
    },
    "/invoices": {
      "post": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "create",
        "tags": [
          "Invoice"
        ],
        "summary": "Create an invoice",
        "description": "Creates a new invoice for a customer. The invoice can include multiple line items and will be associated with the specified customer account.<br><br>The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "Invoice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceDetails"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewInvoice"
              }
            }
          }
        },
        "operationId": "InvoiceController.create"
      },
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "find",
        "tags": [
          "Invoice"
        ],
        "summary": "List invoices",
        "description": "Retrieves a list of invoices. You can filter, sort, and paginate the results using query parameters.",
        "responses": {
          "200": {
            "description": "Array of Invoice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoicesWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invoice.Filter"
                }
              }
            }
          }
        ],
        "operationId": "InvoiceController.find"
      }
    },
    "/login": {
      "post": {
        "x-controller-name": "AuthController",
        "x-operation-name": "login",
        "tags": [
          "Auth"
        ],
        "summary": "User login",
        "description": "Authenticates a user with email and password credentials. Returns access and refresh tokens upon successful authentication.",
        "responses": {
          "200": {
            "description": "Authentication tokens",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Credentials"
              }
            }
          }
        },
        "operationId": "AuthController.login"
      }
    },
    "/master/currencies": {
      "get": {
        "x-controller-name": "CurrencyController",
        "x-operation-name": "findMasterCurrencies",
        "tags": [
          "Currency"
        ],
        "summary": "List master currencies",
        "description": "Retrieves the complete list of all available currencies from the master currency catalog. This list contains all supported currencies that can be added to a tenant configuration.",
        "responses": {
          "200": {
            "description": "Array of CurrencyMaster model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CurrencyMaster"
                  }
                }
              }
            }
          }
        },
        "operationId": "CurrencyController.findMasterCurrencies"
      }
    },
    "/memos": {
      "get": {
        "x-controller-name": "MemoController",
        "x-operation-name": "find",
        "tags": [
          "MemoController"
        ],
        "summary": "List memos",
        "description": "Retrieves a unified list of all memos (credit and debit) for a customer account. Returns both credit and debit memos with a total count. Filter parameter must include accountId in the where clause. Optionally filter by memoType (\"credit\" or \"debit\") to retrieve specific memo types. Supports pagination through limit and offset parameters.",
        "responses": {
          "200": {
            "description": "Unified array of credit and debit memos with count",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "memos": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    },
                    "count": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditMemo.Filter"
                }
              }
            }
          }
        ],
        "operationId": "MemoController.find"
      }
    },
    "/metadata/{variable}": {
      "get": {
        "x-controller-name": "MetaDataController",
        "x-operation-name": "find",
        "tags": [
          "Metadata"
        ],
        "summary": "Retrieve metadata values",
        "description": "Retrieves an array of valid enumeration values for the specified metadata type. This endpoint provides reference data for various system entities including account statuses, subscription statuses, charge types, pricing models, currencies, payment methods, and more.<br><br>Use the metadata type identifier as the variable path parameter to get the corresponding list of valid values.",
        "responses": {
          "200": {
            "description": "Array of valid metadata values for the specified type",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "variable",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "MetaDataController.find"
      }
    },
    "/my-preferences": {
      "patch": {
        "x-controller-name": "MyPreferencesController",
        "x-operation-name": "update",
        "tags": [
          "MyPreferencesController"
        ],
        "summary": "Update my preferences",
        "description": "Changes the signed-in team member's own preferences.",
        "responses": {
          "200": {
            "description": "Preferences after the change",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "dailyDigest": {
                      "type": "boolean",
                      "description": "Email me a summary of what needs my attention each morning"
                    }
                  },
                  "additionalProperties": false
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "dailyDigest": {
                    "type": "boolean",
                    "description": "Email me a summary of what needs my attention each morning"
                  }
                },
                "additionalProperties": false
              }
            }
          }
        },
        "operationId": "MyPreferencesController.update"
      },
      "get": {
        "x-controller-name": "MyPreferencesController",
        "x-operation-name": "find",
        "tags": [
          "MyPreferencesController"
        ],
        "summary": "Get my preferences",
        "description": "The signed-in team member's own preferences, such as the daily summary email.",
        "responses": {
          "200": {
            "description": "Preferences",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "dailyDigest": {
                      "type": "boolean",
                      "description": "Email me a summary of what needs my attention each morning"
                    }
                  },
                  "additionalProperties": false
                }
              }
            }
          }
        },
        "operationId": "MyPreferencesController.find"
      }
    },
    "/mytenant": {
      "get": {
        "x-controller-name": "TenantController",
        "x-operation-name": "findMyTenant",
        "tags": [
          "Tenant"
        ],
        "summary": "Fetch current tenant",
        "description": "Retrieves the details of the current tenant. You can use this endpoint to get information about the tenant associated with the current authenticated user.",
        "responses": {
          "200": {
            "description": "Tenant model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantWithRelations"
                }
              }
            }
          }
        },
        "operationId": "TenantController.findMyTenant"
      }
    },
    "/notifications": {
      "post": {
        "x-controller-name": "NotificationController",
        "x-operation-name": "create",
        "tags": [
          "Notification"
        ],
        "summary": "Send a notification",
        "description": "Sends a direct notification email to specified recipients. This endpoint allows sending ad-hoc notifications with custom subject, body, and recipient list outside of the standard notification templates.",
        "responses": {
          "200": {
            "description": "Notification model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Notification"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewNotification"
              }
            }
          }
        },
        "operationId": "NotificationController.create"
      },
      "get": {
        "x-controller-name": "NotificationController",
        "x-operation-name": "find",
        "tags": [
          "Notification"
        ],
        "summary": "List notifications",
        "description": "Retrieves a list of notifications sent through the system. This includes notification history with details such as recipients, subject, status, and timestamps. Use filters to narrow down results by status, date range, or recipient.",
        "responses": {
          "200": {
            "description": "Array of Notification model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/NotificationWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Notification.Filter"
                }
              }
            }
          }
        ],
        "operationId": "NotificationController.find"
      }
    },
    "/offer-link": {
      "post": {
        "x-controller-name": "OfferController",
        "x-operation-name": "createOfferLink",
        "tags": [
          "Offer"
        ],
        "summary": "Link an offer to an entity",
        "description": "Associates an offer with a rate plan price, addon price, or charge price.",
        "responses": {
          "200": {
            "description": "OfferApplicability model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferApplicabilityResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewOfferApplicability"
              }
            }
          }
        },
        "operationId": "OfferController.createOfferLink"
      }
    },
    "/offers/{id}/activate": {
      "get": {
        "x-controller-name": "OfferController",
        "x-operation-name": "activateOfferbyId",
        "tags": [
          "Offer"
        ],
        "summary": "Activate an offer",
        "description": "Activates an offer making it available for use in subscriptions and purchases. Active offers can be applied to eligible products and rate plans.",
        "responses": {
          "204": {
            "description": "Offer activated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OfferController.activateOfferbyId"
      }
    },
    "/offers/{id}/deactivate": {
      "get": {
        "x-controller-name": "OfferController",
        "x-operation-name": "deactiveOfferById",
        "tags": [
          "Offer"
        ],
        "summary": "Deactivate an offer",
        "description": "Deactivates an offer preventing it from being applied to new subscriptions. Existing subscriptions with this offer remain unaffected.",
        "responses": {
          "204": {
            "description": "Offer deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OfferController.deactiveOfferById"
      }
    },
    "/offers/{id}": {
      "patch": {
        "x-controller-name": "OfferController",
        "x-operation-name": "updateById",
        "tags": [
          "Offer"
        ],
        "summary": "Update an offer",
        "description": "Updates the details of an existing offer using its unique identifier or offer key. You can modify discount amounts, validity periods, applicable products, and other offer attributes.",
        "responses": {
          "204": {
            "description": "Offer PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OfferPartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "OfferController.updateById"
      },
      "get": {
        "x-controller-name": "OfferController",
        "x-operation-name": "findById",
        "tags": [
          "Offer"
        ],
        "summary": "Fetch an offer",
        "description": "Retrieves the details of a specific offer using its unique identifier or offer key. You can use this to get complete information about discounts, promotions, and applicable terms.",
        "responses": {
          "200": {
            "description": "Offer model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offer"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offer.Filter"
                }
              }
            }
          }
        ],
        "operationId": "OfferController.findById"
      },
      "delete": {
        "x-controller-name": "OfferController",
        "x-operation-name": "deleteById",
        "tags": [
          "Offer"
        ],
        "summary": "Delete an offer",
        "description": "Deletes a specific offer using its unique identifier. Deleting an offer removes it permanently from the system.",
        "responses": {
          "204": {
            "description": "Offer DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OfferController.deleteById"
      }
    },
    "/offers": {
      "post": {
        "x-controller-name": "OfferController",
        "x-operation-name": "create",
        "tags": [
          "Offer"
        ],
        "summary": "Create an offer",
        "description": "Creates a new offer or promotion with the specified details. Offers can include discounts, trial periods, or other promotional incentives.",
        "responses": {
          "200": {
            "description": "Offer model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offer"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewOffer"
              }
            }
          }
        },
        "operationId": "OfferController.create"
      },
      "get": {
        "x-controller-name": "OfferController",
        "x-operation-name": "find",
        "tags": [
          "Offer"
        ],
        "summary": "List offers",
        "description": "Retrieves a list of all offers and promotions configured for the tenant. Supports filtering, sorting, and pagination to find specific offers.",
        "responses": {
          "200": {
            "description": "Array of Offer model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OffersWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offer.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "OfferController.find"
      }
    },
    "/orders/estimate": {
      "post": {
        "x-controller-name": "OrderController",
        "x-operation-name": "orderSummary",
        "tags": [
          "Order"
        ],
        "summary": "Estimate order charges",
        "description": "Calculates and provides an estimate of charges for an order before it is placed. This endpoint allows you to preview costs, taxes, and other charges without creating an actual order. For CANCEL SUBSCRIPTION, the Immediately and Specific Date cancel options are supported; a Specific Date credit is labelled Estimated because it is recalculated on the cancel date. End of Term returns 400.",
        "responses": {
          "200": {
            "description": "OrderSummary model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderSummary"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewOrderData"
              }
            }
          }
        },
        "operationId": "OrderController.orderSummary"
      }
    },
    "/orders/place": {
      "post": {
        "x-controller-name": "OrderController",
        "x-operation-name": "create",
        "tags": [
          "Order"
        ],
        "summary": "Place an order",
        "description": "Creates and processes a new order. This endpoint handles order placement for subscriptions, products, or services. The order will be validated, processed, and executed based on the order type and payment terms.",
        "responses": {
          "200": {
            "description": "OrderDetails model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderData"
              }
            }
          }
        },
        "operationId": "OrderController.create"
      }
    },
    "/orders/{orderId}": {
      "get": {
        "x-controller-name": "OrderController",
        "x-operation-name": "findById",
        "tags": [
          "Order"
        ],
        "summary": "Fetch an order",
        "description": "Retrieves the details of a specific order by its unique identifier. Returns comprehensive order information including order items, pricing, status, and associated subscriptions.",
        "responses": {
          "200": {
            "description": "OrderDetails model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OrderController.findById"
      },
      "delete": {
        "x-controller-name": "OrderController",
        "x-operation-name": "deleteById",
        "tags": [
          "Order"
        ],
        "summary": "Delete an order",
        "description": "Deletes an order by its unique identifier. Only orders in \"Created\" status can be deleted.",
        "responses": {
          "204": {
            "description": "Order DELETE success"
          }
        },
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OrderController.deleteById"
      }
    },
    "/orders": {
      "get": {
        "x-controller-name": "OrderController",
        "x-operation-name": "find",
        "tags": [
          "Order"
        ],
        "summary": "List orders",
        "description": "Retrieves a list of orders added.",
        "responses": {
          "200": {
            "description": "Orders model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Orders"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Order.Filter"
                }
              }
            }
          }
        ],
        "operationId": "OrderController.find"
      }
    },
    "/partner/authorized": {
      "get": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "authorized",
        "tags": [
          "Payment"
        ],
        "summary": "OAuth authorization callback",
        "description": "Public redirect target of the Cashfree partner OAuth flow. It does not exchange the code: it hands code and state to a logged-in customer-portal page, which completes the flow via POST /partner/oauth/complete so the account is only attached to the tenant that is logged in and started the flow.",
        "responses": {
          "302": {
            "description": "Redirect to the customer portal"
          }
        },
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "PaymentController.authorized"
      }
    },
    "/partner/oauth/auth_link": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "getAuthLink",
        "tags": [
          "Payment"
        ],
        "summary": "Generate OAuth authentication link",
        "description": "Generates an OAuth authentication link for partner payment gateway integration. This link is used to initiate the OAuth flow for connecting payment gateway accounts.",
        "responses": {
          "200": {
            "description": "A plain string response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "description": "Any JSON object"
        },
        "operationId": "PaymentController.getAuthLink"
      }
    },
    "/partner/oauth/complete": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "completeOAuth",
        "tags": [
          "Payment"
        ],
        "summary": "Complete connecting an existing Cashfree account",
        "description": "Exchanges the OAuth code for the logged-in tenant. Rejected unless the signed state was issued to that same tenant.",
        "responses": {
          "200": {
            "description": "Account connected",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "connected": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "code",
                  "state"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "operationId": "PaymentController.completeOAuth"
      }
    },
    "/payment/auth": {
      "post": {
        "x-controller-name": "AccountController",
        "x-operation-name": "authPayment",
        "tags": [
          "Customer"
        ],
        "responses": {
          "200": {
            "description": "Payment Auth model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentAuth"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AuthorizePayment"
              }
            }
          }
        },
        "operationId": "AccountController.authPayment"
      }
    },
    "/payment-gateway/{pgCode}/merchants/{merchantId}/onboarding-link": {
      "get": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "getMerchantOnboardingLink",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "Get merchant onboarding link",
        "description": "Generates and retrieves the onboarding link for a merchant account. This endpoint provides a secure URL that merchants can use to complete their onboarding process with the payment gateway. The link typically directs merchants to a hosted onboarding flow where they can provide additional information and verify their account.",
        "responses": {
          "200": {
            "description": "OnboardingLink model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingLinkResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "merchantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayController.getMerchantOnboardingLink"
      }
    },
    "/payment-gateway/{pgCode}/merchants/{merchantId}": {
      "get": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "getMerchant",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "Fetch merchant account details",
        "description": "Retrieves the details of a specific merchant account for the payment gateway. This endpoint returns comprehensive information about the merchant including onboarding status, account settings, and verification details. Use the unique merchant identifier to fetch the desired merchant account information.",
        "responses": {
          "200": {
            "description": "Merchant model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "merchantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayController.getMerchant"
      }
    },
    "/payment-gateway/{pgCode}/merchants": {
      "post": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "createMerchant",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "Create a merchant account",
        "description": "Creates a new merchant account for payment gateway onboarding. This endpoint initiates the merchant onboarding process for the specified payment gateway. Use this to set up a merchant profile that will be used for processing payments through the gateway. The merchant account is required before you can accept payments.",
        "responses": {
          "200": {
            "description": "Merchant created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MerchantResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateMerchantRequest"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PaymentGatewayController.createMerchant"
      }
    },
    "/payment-gateway/{pgCode}/onboarding/sync": {
      "post": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "syncOnboarding",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Refresh onboarding status from the gateway",
        "responses": {
          "200": {
            "description": "Payment gateway onboarding state",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayOnboardingState"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayOnboardingController.syncOnboarding"
      }
    },
    "/payment-gateway/{pgCode}/onboarding": {
      "post": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "startOnboarding",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Enable a payment gateway and start merchant onboarding",
        "description": "Creates the partner merchant account for the tenant with the gateway (idempotent). The gateway stays inactive until its onboarding status is ACTIVE.",
        "responses": {
          "200": {
            "description": "Payment gateway onboarding state",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayOnboardingState"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayOnboardingController.startOnboarding"
      },
      "get": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "getOnboardingState",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Get payment gateway onboarding status",
        "responses": {
          "200": {
            "description": "Payment gateway onboarding state",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayOnboardingState"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayOnboardingController.getOnboardingState"
      }
    },
    "/payment-gateway/{pgCode}/onboarding-session": {
      "post": {
        "x-controller-name": "PaymentGatewayOnboardingController",
        "x-operation-name": "createOnboardingSession",
        "tags": [
          "PaymentGatewayOnboardingController"
        ],
        "summary": "Get a fresh hosted onboarding link",
        "description": "Mints a new link to the gateway's hosted KYC page (Cashfree links expire after 1 hour). The return URL is set by BillHive.",
        "responses": {
          "200": {
            "description": "Hosted onboarding link",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingSessionResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "pgCode",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayOnboardingController.createOnboardingSession"
      }
    },
    "/payment-gateway/{id}": {
      "delete": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "deleteById",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "Delete a payment gateway configuration",
        "description": "Deletes a specific payment gateway configuration. This operation removes the payment gateway settings and credentials from the system. Ensure no active transactions or subscriptions are using this gateway before deletion.",
        "responses": {
          "204": {
            "description": "PaymentGateway DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentGatewayController.deleteById"
      }
    },
    "/payment-gateway": {
      "post": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "create",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "Configure a payment gateway",
        "description": "Creates a new payment gateway configuration for the current tenant. This endpoint allows you to set up and configure a payment gateway integration by providing the necessary credentials and settings. The gateway configuration is tenant-specific and enables payment processing for customer transactions.",
        "responses": {
          "200": {
            "description": "PaymentGateway model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewaySetting"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPaymentGatewaySetting"
              }
            }
          }
        },
        "operationId": "PaymentGatewayController.create"
      },
      "get": {
        "x-controller-name": "PaymentGatewayController",
        "x-operation-name": "find",
        "tags": [
          "PaymentGatewayController"
        ],
        "summary": "List payment gateway configurations",
        "description": "Retrieves all payment gateway configurations for the current tenant. This endpoint returns the list of configured payment gateways including their credentials, settings, and status. Use this to view all active payment gateway integrations set up for processing customer payments.",
        "responses": {
          "200": {
            "description": "Array of PaymentGateway model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentGatewaySettingWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewaySetting.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PaymentGatewayController.find"
      }
    },
    "/payment-gateway-masters": {
      "get": {
        "x-controller-name": "PaymentGatewayMasterController",
        "x-operation-name": "find",
        "tags": [
          "Payment Gateway"
        ],
        "summary": "List supported payment gateways",
        "description": "Retrieves the list of all supported payment gateway integrations available in the system. This endpoint returns active payment gateways that can be configured for processing payments. Each gateway includes its unique identifier, name, and code for integration purposes.",
        "responses": {
          "200": {
            "description": "Array of PaymentGatewayMaster model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayMastersWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayMaster.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PaymentGatewayMasterController.find"
      }
    },
    "/payment-gateway-metadata": {
      "get": {
        "x-controller-name": "PublicController",
        "x-operation-name": "find",
        "tags": [
          "PublicController"
        ],
        "summary": "List available payment gateway methods",
        "description": "Retrieves metadata for all available payment gateway methods and configurations. This public endpoint provides information about supported payment methods, gateway capabilities, and required fields for payment processing without requiring authentication.",
        "responses": {
          "200": {
            "description": "Array of PaymentGatewayMetadata model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentGatewayMetadataWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentGatewayMetadata.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PublicController.find"
      }
    },
    "/payment-method-masters": {
      "get": {
        "x-controller-name": "PaymentMethodMasterController",
        "x-operation-name": "find",
        "tags": [
          "Payment Method"
        ],
        "summary": "List supported payment methods",
        "description": "Retrieves the list of all supported payment method types available in the system. This includes various payment methods like credit cards, ACH, and other configured payment options.",
        "responses": {
          "200": {
            "description": "Array of PaymentMethodMaster model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentMethodMasterWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentMethodMaster.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PaymentMethodMasterController.find"
      }
    },
    "/payments": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "create",
        "tags": [
          "Payment"
        ],
        "summary": "Create payment",
        "description": "Creates a new payment record for processing customer payments. This endpoint handles payment creation and triggers payment received notifications.",
        "responses": {
          "200": {
            "description": "Payment model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payment"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPayment"
              }
            }
          }
        },
        "operationId": "PaymentController.create"
      },
      "get": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "find",
        "tags": [
          "Payment"
        ],
        "summary": "List payments",
        "description": "Retrieves a list of all payment records. You can filter, sort, and paginate the results using query parameters.",
        "responses": {
          "200": {
            "description": "Array of Payment model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payment.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PaymentController.find"
      }
    },
    "/payments-page/session": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "createCheckoutSession",
        "tags": [
          "Payment"
        ],
        "summary": "Create checkout session from opaque checkout secret",
        "description": "Exchanges an orderId + opaque checkout secret (body field checkoutSecret or Authorization: Bearer) for a minimal payment page DTO. All failures return an identical generic 401.",
        "responses": {
          "200": {
            "description": "Minimal checkout session",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          },
          "401": {
            "description": "Invalid or expired checkout link"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "orderId": {
                    "type": "string"
                  },
                  "checkoutSecret": {
                    "type": "string"
                  }
                },
                "required": [
                  "orderId"
                ]
              }
            }
          }
        },
        "operationId": "PaymentController.createCheckoutSession"
      }
    },
    "/payments-page": {
      "get": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "getPaymentsPageInfo",
        "tags": [
          "Payment"
        ],
        "summary": "Fetch payment page information",
        "description": "Retrieves comprehensive payment page information including order details, payment gateways, payment methods, and payment requests. This endpoint is used to display a complete payment page to customers.",
        "responses": {
          "200": {
            "description": "Generic response object",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "PaymentController.getPaymentsPageInfo"
      }
    },
    "/periods": {
      "get": {
        "x-controller-name": "PeriodController",
        "x-operation-name": "find",
        "tags": [
          "Period"
        ],
        "summary": "List periods",
        "description": "Retrieves all available billing and subscription period options including daily, monthly, quarterly, semi-annual, and annual periods. These periods define the billing cycles and trial period configurations for subscriptions.",
        "responses": {
          "200": {
            "description": "Array of Period model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PeriodWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PeriodController.find"
      }
    },
    "/pg/{paymentGateway}/onboarding/webhook": {
      "post": {
        "x-controller-name": "CallbackUrlsController",
        "x-operation-name": "merchantOnboardingWebhook",
        "tags": [
          "CallbackUrlsController"
        ],
        "summary": "Payment gateway merchant onboarding webhook",
        "description": "Receives partner merchant-onboarding status events (e.g. Cashfree MERCHANT_ONBOARDING_STATUS) and forwards the raw body to payment-service, which verifies the signature with the partner key and updates the tenant's gateway status.",
        "responses": {
          "200": {
            "description": "Webhook accepted"
          },
          "401": {
            "description": "Invalid signature"
          }
        },
        "parameters": [
          {
            "name": "paymentGateway",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "CallbackUrlsController.merchantOnboardingWebhook"
      }
    },
    "/pg/{paymentGateway}/payment/webhook": {
      "post": {
        "x-controller-name": "CallbackUrlsController",
        "x-operation-name": "cbPaymentSuccess",
        "tags": [
          "CallbackUrlsController"
        ],
        "summary": "Payment gateway webhook",
        "description": "Receives payment webhook notifications from payment gateways (e.g., Cashfree) and processes payment status updates. Supports both direct processing and Camunda workflow integration.",
        "responses": {
          "200": {
            "description": "Webhook processed successfully"
          }
        },
        "parameters": [
          {
            "name": "paymentGateway",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "CallbackUrlsController.cbPaymentSuccess"
      }
    },
    "/ping": {
      "get": {
        "x-controller-name": "PingController",
        "x-operation-name": "ping",
        "tags": [
          "System"
        ],
        "summary": "Health check",
        "description": "Returns a greeting, the current time, the request URL, and request headers to verify the service is running.",
        "responses": {
          "200": {
            "description": "Ping Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PingResponse"
                }
              }
            }
          }
        },
        "operationId": "PingController.ping"
      }
    },
    "/portal/applicable-offers": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findApplicableOffers",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "operationId": "PortalController.findApplicableOffers"
      }
    },
    "/portal/auth/select-account": {
      "post": {
        "x-controller-name": "PortalAuthController",
        "x-operation-name": "selectAccount",
        "tags": [
          "Portal-Auth"
        ],
        "summary": "Pick one of several accounts after a verified code",
        "responses": {
          "200": {
            "description": "A session `{token, expiresAt}`"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "selectionToken",
                  "accountId"
                ],
                "properties": {
                  "selectionToken": {
                    "type": "string",
                    "minLength": 1
                  },
                  "accountId": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              }
            }
          }
        },
        "operationId": "PortalAuthController.selectAccount"
      }
    },
    "/portal/auth/send-code": {
      "post": {
        "x-controller-name": "PortalAuthController",
        "x-operation-name": "sendCode",
        "tags": [
          "Portal-Auth"
        ],
        "summary": "Email a sign-in code to a customer",
        "responses": {
          "202": {
            "description": "Accepted. The same answer whether or not the email has an account."
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "productId",
                  "email"
                ],
                "properties": {
                  "productId": {
                    "type": "string",
                    "minLength": 1
                  },
                  "email": {
                    "type": "string",
                    "format": "email",
                    "minLength": 3,
                    "maxLength": 254
                  }
                }
              }
            }
          }
        },
        "operationId": "PortalAuthController.sendCode"
      }
    },
    "/portal/auth/sign-out": {
      "post": {
        "x-controller-name": "PortalAuthController",
        "x-operation-name": "signOut",
        "tags": [
          "Portal-Auth"
        ],
        "summary": "End the current portal session",
        "responses": {
          "204": {
            "description": "Signed out"
          }
        },
        "operationId": "PortalAuthController.signOut"
      }
    },
    "/portal/auth/verify-code": {
      "post": {
        "x-controller-name": "PortalAuthController",
        "x-operation-name": "verifyCode",
        "tags": [
          "Portal-Auth"
        ],
        "summary": "Exchange an emailed code for a portal session",
        "responses": {
          "200": {
            "description": "A session `{token, expiresAt}`, or `{accounts, selectionToken}` when the email has several accounts."
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "productId",
                  "email",
                  "code"
                ],
                "properties": {
                  "productId": {
                    "type": "string",
                    "minLength": 1
                  },
                  "email": {
                    "type": "string",
                    "format": "email",
                    "minLength": 3,
                    "maxLength": 254
                  },
                  "code": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              }
            }
          }
        },
        "operationId": "PortalAuthController.verifyCode"
      }
    },
    "/portal/client-errors": {
      "post": {
        "x-controller-name": "PortalPublicController",
        "x-operation-name": "clientErrors",
        "tags": [
          "Portal-Public"
        ],
        "summary": "Report an error seen in the portal",
        "responses": {
          "204": {
            "description": "Recorded"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "operationId": "PortalPublicController.clientErrors"
      }
    },
    "/portal/metadata/{variable}": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "metadata",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "variable",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PortalController.metadata"
      }
    },
    "/portal/orders/estimate": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "estimate",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "operationId": "PortalController.estimate"
      }
    },
    "/portal/orders/{orderId}": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findOrderById",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PortalController.findOrderById"
      }
    },
    "/portal/orders": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findOrders",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        ],
        "operationId": "PortalController.findOrders"
      }
    },
    "/portal/products/{productId}/theme": {
      "get": {
        "x-controller-name": "PortalPublicController",
        "x-operation-name": "theme",
        "tags": [
          "Portal-Public"
        ],
        "summary": "The self-serve portal theme of a product",
        "responses": {
          "200": {
            "description": "The theme"
          },
          "404": {
            "description": "The portal is off or the product is unknown"
          }
        },
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PortalPublicController.theme"
      }
    },
    "/portal/rate-plan-prices/{id}/addons": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findAddons",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        ],
        "operationId": "PortalController.findAddons"
      }
    },
    "/portal/rate-plan-prices": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findRatePlanPrices",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        ],
        "operationId": "PortalController.findRatePlanPrices"
      }
    },
    "/portal/subscriptions/{subscriptionId}/cancel": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "cancel",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PortalController.cancel"
      }
    },
    "/portal/subscriptions/{subscriptionId}/convert-trial": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "convertTrial",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "PortalController.convertTrial"
      }
    },
    "/portal/subscriptions/{id}/pause": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "pause",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PortalController.pause"
      }
    },
    "/portal/subscriptions/{subscriptionId}/reactivate": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "reactivate",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "PortalController.reactivate"
      }
    },
    "/portal/subscriptions/{subscriptionId}/renew": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "renew",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "PortalController.renew"
      }
    },
    "/portal/subscriptions/{id}/resume": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "resume",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PortalController.resume"
      }
    },
    "/portal/subscriptions/{id}": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findSubscriptionById",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        ],
        "operationId": "PortalController.findSubscriptionById"
      }
    },
    "/portal/subscriptions": {
      "get": {
        "x-controller-name": "PortalController",
        "x-operation-name": "findSubscriptions",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        ],
        "operationId": "PortalController.findSubscriptions"
      }
    },
    "/portal/{accountId}/subscriptions/{subscriptionId}/addons/recommended": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "addRecommendedAddons",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "PortalController.addRecommendedAddons"
      }
    },
    "/portal/{accountId}/subscriptions/{subscriptionId}/change-frequency": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "changeFrequency",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "PortalController.changeFrequency"
      }
    },
    "/portal/{accountId}/subscriptions/{subscriptionId}/change-plan": {
      "post": {
        "x-controller-name": "PortalController",
        "x-operation-name": "changePlan",
        "tags": [
          "Portal"
        ],
        "responses": {
          "200": {
            "description": "Result of the matching merchant endpoint"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "PortalController.changePlan"
      }
    },
    "/portal-sessions": {
      "post": {
        "x-controller-name": "PortalSessionController",
        "x-operation-name": "create",
        "tags": [
          "Portal-Session"
        ],
        "summary": "Create a customer portal session",
        "description": "Called from a merchant's server with a full-access API key. Returns a short-lived token that signs the customer in to the self-serve portal.",
        "responses": {
          "201": {
            "description": "Portal session",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "token": {
                      "type": "string"
                    },
                    "expiresAt": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "productId",
                  "accountId"
                ],
                "properties": {
                  "productId": {
                    "type": "string"
                  },
                  "accountId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "operationId": "PortalSessionController.create"
      }
    },
    "/products/{id}/prices": {
      "get": {
        "x-controller-name": "ProductController",
        "x-operation-name": "findRatePlanPrices",
        "tags": [
          "Product"
        ],
        "summary": "Fetch all prices for product",
        "description": "Retrieves all active rate plan prices for a specific product. This endpoint returns a filtered list of rate plans with their pricing information.",
        "responses": {
          "200": {
            "description": "RatePlanPrices model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPriceView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ProductController.findRatePlanPrices"
      }
    },
    "/products/{id}/pricing-table": {
      "get": {
        "x-controller-name": "ProductController",
        "x-operation-name": "getPricingTable",
        "tags": [
          "Product"
        ],
        "summary": "Fetch pricing table for product",
        "description": "Retrieves the pricing table for a specific product, including all rate plans and their associated pricing details with add-ons.",
        "responses": {
          "200": {
            "description": "Array of RatePlanPriceDetails model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlanPriceViewDetailsWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ProductController.getPricingTable"
      }
    },
    "/products/{id}": {
      "patch": {
        "x-controller-name": "ProductController",
        "x-operation-name": "updateById",
        "tags": [
          "Product"
        ],
        "summary": "Update product",
        "description": "Updates the product resource with the provided details.",
        "responses": {
          "204": {
            "description": "Product PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ProductController.updateById"
      },
      "get": {
        "x-controller-name": "ProductController",
        "x-operation-name": "findById",
        "tags": [
          "Product"
        ],
        "summary": "Fetch product",
        "description": "Retrieves the details of a specific product. You can use the unique identifier for a particular product to retrieve the desired details.",
        "responses": {
          "200": {
            "description": "Product model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ProductController.findById"
      },
      "delete": {
        "x-controller-name": "ProductController",
        "x-operation-name": "deleteById",
        "tags": [
          "Product"
        ],
        "summary": "Delete product",
        "description": "Deletes a specific product from the catalog.",
        "responses": {
          "204": {
            "description": "Product DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ProductController.deleteById"
      }
    },
    "/products": {
      "post": {
        "x-controller-name": "ProductController",
        "x-operation-name": "create",
        "tags": [
          "Product"
        ],
        "summary": "Create product",
        "description": "Creates a new product in the catalog. The product can be assigned rate plans and pricing details after creation.",
        "responses": {
          "200": {
            "description": "Product model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Product"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewProduct"
              }
            }
          }
        },
        "operationId": "ProductController.create"
      },
      "get": {
        "x-controller-name": "ProductController",
        "x-operation-name": "find",
        "tags": [
          "Product"
        ],
        "summary": "List products",
        "description": "Retrieves a list of all products added to the catalog.",
        "responses": {
          "200": {
            "description": "Array of Product model instances",
            "content": {
              "application/json": {}
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Product.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ProductController.find"
      }
    },
    "/public/orders/{orderId}": {
      "get": {
        "x-controller-name": "OrderController",
        "x-operation-name": "findOrderStatusById",
        "tags": [
          "Order"
        ],
        "summary": "Fetch order status",
        "description": "Retrieves the status of a BillHive order by its order ID, without authentication. Used by the payment checkout page to confirm the outcome after the customer returns from the payment gateway. `status` is SUCCESS as soon as the latest payment attempt for the order is paid (or the order is past payment), FAILURE when that attempt failed or the order is Failed or Cancelled (with `failed_code` and `failed_message` from the attempt), otherwise PENDING.",
        "responses": {
          "200": {
            "description": "Order status",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "SUCCESS",
                        "FAILURE",
                        "PENDING"
                      ]
                    },
                    "failed_code": {
                      "type": "string"
                    },
                    "failed_message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "OrderController.findOrderStatusById"
      }
    },
    "/public/payments/subscription-callback": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "handleSubscriptionPaymentCallback",
        "tags": [
          "Payment",
          "Payment"
        ],
        "summary": "Subscription payment callback handler",
        "description": "Handles subscription-specific payment callback notifications from payment gateways. This alternative webhook endpoint accepts subscriptionId directly for cases where the payment gateway knows the subscription ID. It correlates payment status to subscription creation workflows.",
        "responses": {
          "200": {
            "description": "Subscription payment callback processed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "subscriptionId": {
                    "type": "string"
                  },
                  "orderId": {
                    "type": "string"
                  },
                  "paymentSuccess": {
                    "type": "boolean"
                  },
                  "paymentTransactionId": {
                    "type": "string"
                  },
                  "paymentError": {
                    "type": "string"
                  }
                },
                "required": [
                  "subscriptionId",
                  "paymentSuccess"
                ]
              }
            }
          },
          "description": "Subscription payment callback payload"
        },
        "operationId": "PaymentController.handleSubscriptionPaymentCallback"
      }
    },
    "/public/payments/webhook": {
      "post": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "handlePaymentWebhook",
        "tags": [
          "Payment",
          "Payment"
        ],
        "summary": "Payment gateway webhook handler",
        "description": "Handles payment callback notifications from payment gateways. This endpoint receives payment status updates and correlates them to waiting Camunda process instances for subscription creation. The webhook processes payment success/failure and triggers appropriate workflow actions.",
        "responses": {
          "200": {
            "description": "Payment webhook processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "processInstanceId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "orderId": {
                    "type": "string"
                  },
                  "subscriptionId": {
                    "type": "string"
                  },
                  "paymentSuccess": {
                    "type": "boolean"
                  },
                  "paymentTransactionId": {
                    "type": "string"
                  },
                  "paymentError": {
                    "type": "string"
                  },
                  "paymentIntentId": {
                    "type": "string"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "currency": {
                    "type": "string"
                  }
                },
                "required": [
                  "orderId",
                  "paymentSuccess"
                ]
              }
            }
          },
          "description": "Payment gateway webhook payload"
        },
        "operationId": "PaymentController.handlePaymentWebhook"
      }
    },
    "/public/rate-plan-prices": {
      "get": {
        "x-controller-name": "PublicController",
        "x-operation-name": "findCheckoutRatePlans",
        "tags": [
          "PublicController"
        ],
        "summary": "List public rate plan prices",
        "description": "Retrieves publicly available rate plan pricing information for checkout and subscription flows. This unauthenticated endpoint allows potential customers to view pricing details, product offerings, and rate plan configurations before creating an account or subscription.",
        "responses": {
          "200": {
            "description": "Array of RatePlanPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlanPriceViewDetailsWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPrice.Filter"
                }
              }
            }
          }
        ],
        "operationId": "PublicController.findCheckoutRatePlans"
      }
    },
    "/rate-plan-features/{id}": {
      "patch": {
        "x-controller-name": "RatePlanFeatureController",
        "x-operation-name": "updateById",
        "tags": [
          "RatePlanFeature"
        ],
        "summary": "Update rate plan feature value",
        "description": "Updates the entitlement value for a rate plan feature attachment.",
        "responses": {
          "204": {
            "description": "RatePlanFeature PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RatePlanFeaturePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanFeatureController.updateById"
      },
      "get": {
        "x-controller-name": "RatePlanFeatureController",
        "x-operation-name": "findById",
        "tags": [
          "RatePlanFeature"
        ],
        "summary": "Fetch a rate plan feature",
        "description": "Retrieves a specific rate plan feature attachment by ID.",
        "responses": {
          "200": {
            "description": "RatePlanFeature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanFeature"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanFeature.Filter"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanFeatureController.findById"
      },
      "delete": {
        "x-controller-name": "RatePlanFeatureController",
        "x-operation-name": "deleteById",
        "tags": [
          "RatePlanFeature"
        ],
        "summary": "Detach feature from rate plan",
        "description": "Removes a feature attachment from a rate plan.",
        "responses": {
          "204": {
            "description": "RatePlanFeature DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanFeatureController.deleteById"
      }
    },
    "/rate-plan-features": {
      "post": {
        "x-controller-name": "RatePlanFeatureController",
        "x-operation-name": "create",
        "tags": [
          "RatePlanFeature"
        ],
        "summary": "Attach feature to rate plan",
        "description": "Attaches a feature to a rate plan with a specific entitlement value.",
        "responses": {
          "200": {
            "description": "RatePlanFeature model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanFeature"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewRatePlanFeature"
              }
            }
          }
        },
        "operationId": "RatePlanFeatureController.create"
      },
      "get": {
        "x-controller-name": "RatePlanFeatureController",
        "x-operation-name": "find",
        "tags": [
          "RatePlanFeature"
        ],
        "summary": "List rate plan features",
        "description": "Retrieves features attached to rate plans. Filter by ratePlanId to get features for a specific plan.",
        "responses": {
          "200": {
            "description": "Array of RatePlanFeature model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlanFeatureWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanFeature.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanFeatureController.find"
      }
    },
    "/rate-plan-prices/{id}/activate": {
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "activateRatePlanPrice",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Activate rate plan price",
        "description": "Activates a specific rate plan price by changing its status to active. Active prices can be used for new subscriptions.",
        "responses": {
          "204": {
            "description": "RatePlan price activated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.activateRatePlanPrice"
      }
    },
    "/rate-plan-prices/{id}/addons": {
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "getAddonsByRatePlanPriceId",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List addons for rate plan price",
        "description": "Retrieves all addons associated with a specific rate plan price. Supports filtering, ordering, and pagination.",
        "responses": {
          "200": {
            "description": "Array of RatePlanPriceAddonPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlanPriceAddonPriceView"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPriceAddonPriceView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.getAddonsByRatePlanPriceId"
      }
    },
    "/rate-plan-prices/{id}/deactivate": {
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "deactivateRatePlanPrice",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Deactivate rate plan price",
        "description": "Deactivates a specific rate plan price by changing its status to inactive. Inactive prices cannot be used for new subscriptions.",
        "responses": {
          "204": {
            "description": "RatePlan price deactivated successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.deactivateRatePlanPrice"
      }
    },
    "/rate-plan-prices/{id}": {
      "patch": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "updatePriceById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Update RatePlan Price instance based on key",
        "description": "Update RatePlan Price instance based on key. This key could be rate_plan_price_key or id.",
        "responses": {
          "204": {
            "description": "RatePlan Price PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "applyTo",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RatePlanPricePartialExcluding_id-creditPacks-grantAmount-grantFrequency-rollover-creditExpiryDays-walletZeroBalanceAction-autoTopUpPack-autoTopUpThreshold_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanController.updatePriceById"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "findPriceById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Fetch rate plan price",
        "description": "Retrieves the details of a specific rate plan price. You can use either the unique identifier (UUID) or the rate plan price key to retrieve the desired price.",
        "responses": {
          "200": {
            "description": "RatePlanPrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPrice"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlan.Filter"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.findPriceById"
      },
      "delete": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "deleteRatePlanPriceById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Delete rate plan price",
        "description": "Deletes a specific rate plan price.",
        "responses": {
          "204": {
            "description": "RatePlanPrice DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.deleteRatePlanPriceById"
      }
    },
    "/rate-plan-prices": {
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "findRatePlanPrices",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List all rate plan prices",
        "description": "Retrieves a list of all rate plan prices across all rate plans. Supports filtering, ordering, and pagination.",
        "responses": {
          "200": {
            "description": "Array of RatePlanPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlanPricesWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPriceView.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.findRatePlanPrices"
      }
    },
    "/rate-plans/{ratePlanId}/addons/{addonId}": {
      "patch": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "updateAddonLink",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Update addon link on rate plan",
        "description": "Updates the link properties (applicability, isPriceIncluded) between an addon and a rate plan.",
        "responses": {
          "204": {
            "description": "RatePlanAddon PATCH success"
          }
        },
        "parameters": [
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "addonId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "applicability": {
                    "type": "string"
                  },
                  "isPriceIncluded": {
                    "type": "boolean"
                  }
                }
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "RatePlanController.updateAddonLink"
      },
      "delete": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "detachAddon",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Detach addon from rate plan",
        "description": "Removes the link between an addon and a rate plan.",
        "responses": {
          "204": {
            "description": "RatePlanAddon DELETE success"
          }
        },
        "parameters": [
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "addonId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.detachAddon"
      }
    },
    "/rate-plans/{id}/addons": {
      "post": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "attachAddon",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Attach addon to rate plan",
        "description": "Attaches an addon to a specific rate plan. Addons are optional features or services that can be added to a base rate plan.",
        "responses": {
          "200": {
            "description": "RatePlanAddon model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanAddon"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewRatePlanAddon"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanController.attachAddon"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "getAddonsByRatePlanId",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List addons for rate plan",
        "description": "Retrieves all addons associated with a specific rate plan. Returns a list of optional features or services attached to the rate plan.",
        "responses": {
          "200": {
            "description": "Array of RatePlanAddon model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanAddons"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.getAddonsByRatePlanId"
      }
    },
    "/rate-plans/{ratePlanId}/charges/{chargeId}": {
      "patch": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "updateChargeLink",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Update charge link on rate plan",
        "description": "Updates the link properties (triggerCondition) between a charge and a rate plan.",
        "responses": {
          "204": {
            "description": "RatePlanCharge PATCH success"
          }
        },
        "parameters": [
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "chargeId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "triggerCondition": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "RatePlanController.updateChargeLink"
      },
      "delete": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "detachCharge",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Detach charge from rate plan",
        "description": "Removes the link between a charge and a rate plan.",
        "responses": {
          "204": {
            "description": "RatePlanCharge DELETE success"
          }
        },
        "parameters": [
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "chargeId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.detachCharge"
      }
    },
    "/rate-plans/{id}/charges": {
      "post": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "attachCharge",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Attach charge to rate plan",
        "description": "Attaches a charge to a specific rate plan. Charges define the pricing components and billing terms for the rate plan.",
        "responses": {
          "200": {
            "description": "RatePlanCharge model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanCharge"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewRatePlanCharge"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanController.attachCharge"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "getChargesByRatePlanId",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List charges for rate plan",
        "description": "Retrieves all charges associated with a specific rate plan. Returns a list of pricing components and billing terms attached to the rate plan.",
        "responses": {
          "200": {
            "description": "Array of RatePlanCharge model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanCharges"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.getChargesByRatePlanId"
      }
    },
    "/rate-plans/{id}/prices": {
      "post": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "createPrice",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Create rate plan price",
        "description": "Creates a new price for a specific rate plan. The price is created with draft status and MRR (Monthly Recurring Revenue) is automatically calculated based on billing cycle.",
        "responses": {
          "200": {
            "description": "RatePlanPrice model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPrice"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewRatePlanPrice"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanController.createPrice"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "findRatePlanPricesByRatePlanId",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List prices for rate plan",
        "description": "Retrieves all prices associated with a specific rate plan. Supports filtering, ordering, and pagination.",
        "responses": {
          "200": {
            "description": "Array of RatePlanPrice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPrices"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlanPriceView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.findRatePlanPricesByRatePlanId"
      }
    },
    "/rate-plans/{id}": {
      "patch": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "updateById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Update rate plan",
        "description": "Updates a rate plan resource. You can use either the unique identifier (UUID) or the rate plan key to update the desired rate plan. Handles pricing table configuration when visibility in checkout is modified.",
        "responses": {
          "204": {
            "description": "RatePlan PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RatePlanPartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "RatePlanController.updateById"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "findById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Fetch rate plan",
        "description": "Retrieves the details of a specific rate plan. You can use either the unique identifier (UUID) or the rate plan key to retrieve the desired rate plan.",
        "responses": {
          "200": {
            "description": "RatePlan model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlan"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlan.Filter"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.findById"
      },
      "delete": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "deleteById",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Delete rate plan",
        "description": "Deletes a specific rate plan asynchronously. Also removes the rate plan from pricing table configuration if it was visible in checkout.",
        "responses": {
          "204": {
            "description": "RatePlan DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "RatePlanController.deleteById"
      }
    },
    "/rate-plans": {
      "post": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "create",
        "tags": [
          "Rate Plan"
        ],
        "summary": "Create rate plan",
        "description": "Creates a new rate plan with draft status. Rate plans define pricing structures for products and can be configured for visibility in checkout.<br><br>The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "RatePlan model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlan"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewRatePlan"
              }
            }
          }
        },
        "operationId": "RatePlanController.create"
      },
      "get": {
        "x-controller-name": "RatePlanController",
        "x-operation-name": "find",
        "tags": [
          "Rate Plan"
        ],
        "summary": "List rate plans",
        "description": "Retrieves a list of all rate plans for the current tenant. Supports filtering, ordering, and pagination.",
        "responses": {
          "200": {
            "description": "Array of RatePlan model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RatePlansWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RatePlan.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "RatePlanController.find"
      }
    },
    "/refreshToken": {
      "post": {
        "x-controller-name": "AuthController",
        "x-operation-name": "refresh",
        "tags": [
          "Auth"
        ],
        "summary": "Refresh access token",
        "description": "Generates a new access token using a valid refresh token. Use this endpoint when the access token has expired.",
        "responses": {
          "200": {
            "description": "New access and refresh tokens",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "accessToken": {
                      "type": "string"
                    },
                    "refreshToken": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "refreshToken"
                ],
                "properties": {
                  "refreshToken": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "description": "Reissuing Access Token",
          "required": true
        },
        "operationId": "AuthController.refresh"
      }
    },
    "/reports/{questionType}": {
      "get": {
        "x-controller-name": "AnalyticsController",
        "x-operation-name": "getReport",
        "tags": [
          "Analytics"
        ],
        "summary": "Get report by question type",
        "description": "Retrieves a report based on the specified question type for analytics purposes.",
        "responses": {
          "200": {
            "description": "Report data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/loopback.Count"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "questionType",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "AnalyticsController.getReport"
      }
    },
    "/reset-password": {
      "post": {
        "x-controller-name": "AuthController",
        "x-operation-name": "resetPassword",
        "tags": [
          "Auth"
        ],
        "summary": "Change password",
        "description": "Changes the logged-in user's password. Requires the current password; newPassword must match confirmPassword.",
        "responses": {
          "200": {
            "description": "Password changed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "currentPassword",
                  "newPassword",
                  "confirmPassword"
                ],
                "properties": {
                  "currentPassword": {
                    "type": "string",
                    "minLength": 1
                  },
                  "newPassword": {
                    "type": "string",
                    "minLength": 1
                  },
                  "confirmPassword": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              }
            }
          }
        },
        "operationId": "AuthController.resetPassword"
      }
    },
    "/roles": {
      "get": {
        "x-controller-name": "RoleController",
        "x-operation-name": "find",
        "tags": [
          "Access Management"
        ],
        "summary": "List roles",
        "description": "Retrieves a list of all roles available in the system. Roles define sets of permissions that can be assigned to users for access control and authorization purposes.",
        "responses": {
          "200": {
            "description": "Array of Role model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": "object"
                }
              }
            }
          }
        },
        "operationId": "RoleController.find"
      }
    },
    "/settings": {
      "patch": {
        "x-controller-name": "SubscriptionSettingsController",
        "x-operation-name": "updateById",
        "tags": [
          "Settings"
        ],
        "summary": "Update subscription settings",
        "description": "Updates subscription settings for the tenant. Allows modification of subscription-related configuration.",
        "responses": {
          "204": {
            "description": "SubscriptionSettings PATCH success"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionSettingsPartial"
              }
            }
          }
        },
        "operationId": "SubscriptionSettingsController.updateById"
      }
    },
    "/smtp-server": {
      "get": {
        "x-controller-name": "ConfigureSmtpServerController",
        "x-operation-name": "find",
        "tags": [
          "Settings"
        ],
        "summary": "List configured SMTP servers",
        "description": "Retrieves a list of all configured SMTP servers for email notifications. This endpoint returns SMTP server configurations including host, port, authentication settings, and connection security details.",
        "responses": {
          "200": {
            "description": "Array of SmtpServer model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SmtpServerWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmtpServer.Filter"
                }
              }
            }
          }
        ],
        "operationId": "ConfigureSmtpServerController.find"
      }
    },
    "/subscription-settings": {
      "post": {
        "x-controller-name": "SubscriptionSettingsController",
        "x-operation-name": "create",
        "tags": [
          "Settings"
        ],
        "summary": "Create subscription settings",
        "description": "Creates new subscription settings for the tenant. This allows configuration of subscription-related preferences and defaults.",
        "responses": {
          "200": {
            "description": "SubscriptionSettings model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionSettings"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewSubscriptionSettings"
              }
            }
          }
        },
        "operationId": "SubscriptionSettingsController.create"
      },
      "get": {
        "x-controller-name": "SubscriptionSettingsController",
        "x-operation-name": "find",
        "tags": [
          "Settings"
        ],
        "summary": "List subscription settings",
        "description": "Retrieves a list of subscription settings configured for the tenant.",
        "responses": {
          "200": {
            "description": "Array of SubscriptionSettings model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SubscriptionSettingsWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionSettings.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionSettingsController.find"
      }
    },
    "/subscription-terms/{termSubscriptionId}/addons": {
      "get": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "getSubscriptionAddons",
        "tags": [
          "Subscription"
        ],
        "summary": "Get subscription term addons",
        "description": "Retrieves the list of addons attached to a subscription term.",
        "responses": {
          "200": {
            "description": "Subscription addons array",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SubscriptionAddonView"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "termSubscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionAddonView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionController.getSubscriptionAddons"
      }
    },
    "/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}/remove": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "removeAddon",
        "tags": [
          "Subscription"
        ],
        "summary": "Remove an add-on from a subscription",
        "description": "Removes an add-on from an Active subscription. Immediately ends it today and, when Prorated Billing is on, credits the unused days (an account-wide credit note). End of Term keeps it until the term ends and leaves it off the renewal. Either way the pending renewal is rebuilt without it. Fails with 400 for a mandatory or price-included add-on. Self-serve needs the enableManageAddons feature flag.",
        "responses": {
          "200": {
            "description": "Add-on removal started (the order, or the rebuilt renewal for End of Term)"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionAddonId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "option": {
                    "type": "string"
                  },
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionController.removeAddon"
      }
    },
    "/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}": {
      "patch": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "changeAddonQuantity",
        "tags": [
          "Subscription"
        ],
        "summary": "Change the quantity of a subscription add-on",
        "description": "Sets the quantity of an add-on on an Active subscription. A rise Immediately bills the extra units prorated to the term end (add-addon workflow); a drop Immediately credits the dropped units for the unused days when Prorated Billing is on. End of Term only changes the renewal. Self-serve needs the enableManageAddons feature flag.",
        "responses": {
          "200": {
            "description": "Quantity change started (the order, or the rebuilt renewal for End of Term)"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionAddonId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "quantity": {},
                  "option": {
                    "type": "string"
                  },
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionController.changeAddonQuantity"
      }
    },
    "/subscriptions/{id}/audit-log": {
      "get": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "getAuditLog",
        "tags": [
          "Subscription"
        ],
        "summary": "Fetch subscription audit log",
        "description": "Retrieves the audit log details of a subscription. Information about specific actions or events related to a subscription. Audit logs are used to track and monitor activities performed on subscriptions.",
        "responses": {
          "200": {
            "description": "Array of AuditLog model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AuditLog"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionController.getAuditLog"
      }
    },
    "/subscriptions/{subscriptionId}/cancel": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "cancelSubscription",
        "tags": [
          "Subscription"
        ],
        "summary": "Cancel a subscription",
        "description": "Cancels an active or paused subscription. Creates a cancel order and starts the Camunda cancel workflow. Active, Paused, Trial, Future, Non Renewing and In Dunning subscriptions can be cancelled (the last four immediately only).",
        "responses": {
          "200": {
            "description": "Subscription cancelled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscription"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelSubscription"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.cancelSubscription"
      }
    },
    "/subscriptions/{id}/charges/{chargeId}": {
      "delete": {
        "x-controller-name": "SubscriptionChargesController",
        "x-operation-name": "cancel",
        "tags": [
          "Subscription charges"
        ],
        "summary": "Cancel a pending charge",
        "responses": {
          "200": {
            "description": "The cancelled charge; 409 unless it is still PENDING"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "chargeId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionChargesController.cancel"
      }
    },
    "/subscriptions/{id}/charges": {
      "post": {
        "x-controller-name": "SubscriptionChargesController",
        "x-operation-name": "create",
        "tags": [
          "Subscription charges"
        ],
        "summary": "Add a pending charge to a subscription",
        "description": "Either {componentId, quantity} for an EVENT (or On Demand ONE_TIME) component of the current price, or {name, amount, passThrough?} for an ad-hoc charge. It is billed on the next invoice. 422 once the subscription is Cancelled or Expired, or its cancellation has taken effect.",
        "responses": {
          "200": {
            "description": "The pending charge"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionChargesController.create"
      },
      "get": {
        "x-controller-name": "SubscriptionChargesController",
        "x-operation-name": "find",
        "tags": [
          "Subscription charges"
        ],
        "summary": "List a subscription’s pending charges",
        "responses": {
          "200": {
            "description": "Pending charges, newest first"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "status",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "SubscriptionChargesController.find"
      }
    },
    "/subscriptions/{subscriptionId}/contract-terms": {
      "patch": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "updateContractTerms",
        "tags": [
          "Subscription"
        ],
        "summary": "Set contract term overrides of a subscription",
        "description": "Sets per-subscription contract terms (minimum commitment, notice period, early-termination fee). A non-null value overrides the rate plan's value for this subscription; send null to fall back to the plan again. Fields left out are unchanged.",
        "responses": {
          "204": {
            "description": "Contract terms updated"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "minimumCommitmentMonths": {
                    "type": "integer",
                    "minimum": 0,
                    "nullable": true
                  },
                  "noticePeriodDays": {
                    "type": "integer",
                    "minimum": 0,
                    "nullable": true
                  },
                  "earlyTerminationFeeType": {
                    "type": "string",
                    "enum": [
                      "FIXED",
                      "PERCENTAGE",
                      "REMAINING_VALUE",
                      null
                    ],
                    "nullable": true
                  },
                  "earlyTerminationFeeValue": {
                    "type": "number",
                    "minimum": 0,
                    "nullable": true
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.updateContractTerms"
      }
    },
    "/subscriptions/{subscriptionId}/convert-trial": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "convertTrial",
        "tags": [
          "Subscription"
        ],
        "summary": "Convert a trial to paid now",
        "description": "Ends the trial today and starts the paid term today. The customer is billed in full for the first term, with no credit for unused trial days. Replaces the expiring-soon workflow with the trial activation workflow. Fails with 400 unless the subscription is in Trial. Self-serve needs the enableConvertTrial feature flag.",
        "responses": {
          "200": {
            "description": "Trial conversion started",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "trialEndDate": {
                      "type": "string"
                    },
                    "paidTermStart": {
                      "type": "string"
                    },
                    "orderId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.convertTrial"
      }
    },
    "/subscriptions/{subscriptionId}/entitlements/resolve": {
      "post": {
        "x-controller-name": "SubscriptionEntitlementController",
        "x-operation-name": "resolve",
        "tags": [
          "SubscriptionEntitlement"
        ],
        "summary": "Resolve entitlements",
        "description": "Recomputes all entitlements for a subscription from its plan and active addons. The X-Wallet-Exhausted header carries walletExhausted (see GET).",
        "responses": {
          "200": {
            "description": "Resolved entitlements",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SubscriptionEntitlement"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "ratePlanId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addonIds": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                },
                "required": [
                  "ratePlanId"
                ]
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionEntitlementController.resolve"
      }
    },
    "/subscriptions/{subscriptionId}/entitlements/{id}": {
      "patch": {
        "x-controller-name": "SubscriptionEntitlementController",
        "x-operation-name": "updateById",
        "tags": [
          "SubscriptionEntitlement"
        ],
        "summary": "Update entitlement override",
        "description": "Updates an override for a specific subscription entitlement.",
        "responses": {
          "204": {
            "description": "SubscriptionEntitlement PATCH success"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriptionEntitlementPartialExcluding_id-subscriptionId_"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionEntitlementController.updateById"
      },
      "delete": {
        "x-controller-name": "SubscriptionEntitlementController",
        "x-operation-name": "deleteById",
        "tags": [
          "SubscriptionEntitlement"
        ],
        "summary": "Remove entitlement override",
        "description": "Removes an override, reverting the entitlement to the plan default on next resolve.",
        "responses": {
          "204": {
            "description": "SubscriptionEntitlement DELETE success"
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionEntitlementController.deleteById"
      }
    },
    "/subscriptions/{subscriptionId}/entitlements": {
      "post": {
        "x-controller-name": "SubscriptionEntitlementController",
        "x-operation-name": "create",
        "tags": [
          "SubscriptionEntitlement"
        ],
        "summary": "Add/override entitlement",
        "description": "Creates or overrides an entitlement for a specific subscription.",
        "responses": {
          "200": {
            "description": "SubscriptionEntitlement model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionEntitlement"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewSubscriptionEntitlement"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionEntitlementController.create"
      },
      "get": {
        "x-controller-name": "SubscriptionEntitlementController",
        "x-operation-name": "findBySubscription",
        "tags": [
          "SubscriptionEntitlement"
        ],
        "summary": "Get subscription entitlements",
        "description": "Retrieves all resolved entitlements for a subscription. The X-Wallet-Exhausted header is true when the subscription's price blocks on an empty prepaid wallet and its projected balance reached 0 at the last check.",
        "responses": {
          "200": {
            "description": "Array of SubscriptionEntitlement model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SubscriptionEntitlement"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionEntitlementController.findBySubscription"
      }
    },
    "/subscriptions/{subscriptionId}/extend-trial": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "extendTrial",
        "tags": [
          "Subscription"
        ],
        "summary": "Extend a trial",
        "description": "Moves the end of a Trial subscription to a later date. Updates the trial term, the activation order and the expiring-soon workflow, and tells the customer. Fails with 400 once the trial is converting (Trial Pending Activation) or when the date is not after the current trial end. Merchant only.",
        "responses": {
          "200": {
            "description": "Trial extended",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "termEndDate": {
                      "type": "string"
                    },
                    "expiringSoonDate": {
                      "type": "string"
                    },
                    "activationScheduleDate": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "trialEndDate"
                ],
                "properties": {
                  "trialEndDate": {
                    "type": "string"
                  },
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.extendTrial"
      }
    },
    "/subscriptions/{subscriptionId}/next-billing-date": {
      "patch": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "editNextBillingDate",
        "tags": [
          "Subscription"
        ],
        "summary": "Edit the next billing date",
        "description": "Moves the next billing date of an Active subscription: the current term ends the day before, the pending renewal order is rebuilt for the new date (an already raised renewal invoice is voided or credited) and the expiring-soon workflow restarts. No charge or credit is made for the days moved. Fails with 400 unless the subscription is Active, when the date is not after today or is the current date, when a scheduled change, cancellation or pause is waiting, a Fixed price has billed every cycle, or the mandate has fixed debit dates. Merchant only.",
        "responses": {
          "200": {
            "description": "Next billing date moved",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "nextBillingDate": {
                      "type": "string"
                    },
                    "termEndDate": {
                      "type": "string"
                    },
                    "expiringSoonDate": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "nextBillingDate"
                ],
                "properties": {
                  "nextBillingDate": {
                    "type": "string"
                  },
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.editNextBillingDate"
      }
    },
    "/subscriptions/{id}/pause": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "pauseSubscription",
        "tags": [
          "Subscription"
        ],
        "summary": "Pause a subscription",
        "description": "Pauses an active subscription. Creates a pause order and starts the Camunda pause workflow. Only ACTIVE subscriptions can be paused.",
        "responses": {
          "200": {
            "description": "Subscription paused successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscription"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PauseSubscription"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.pauseSubscription"
      }
    },
    "/subscriptions/{subscriptionId}/reactivate": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "reactivateSubscription",
        "tags": [
          "Subscription"
        ],
        "summary": "Reactivate an expired or cancelled subscription",
        "description": "Starts a new term today on the same subscription record, at the plan's current list price plus its mandatory add-ons. The subscription becomes Active once the first payment is collected (Pre-Payment Access decides when). Only Expired or Cancelled subscriptions on a plan price that is still Active can be reactivated.",
        "responses": {
          "200": {
            "description": "Reactivation order placed and workflow started",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.reactivateSubscription"
      }
    },
    "/subscriptions/{subscriptionId}/remove-scheduled-cancellation": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "removeScheduledCancellation",
        "tags": [
          "Subscription"
        ],
        "summary": "Remove a scheduled cancellation",
        "description": "Removes an End of Term or Specific Date cancellation that has not taken effect yet. Stops the cancel workflow, cancels the cancel order and sets the subscription back to the status it had before the cancellation was scheduled (Active, Paused or Non Renewing). Fails with 400 when the subscription has no scheduled cancellation.",
        "responses": {
          "200": {
            "description": "Scheduled cancellation removed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "subscriptionId": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "cancelledOrderId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.removeScheduledCancellation"
      }
    },
    "/subscriptions/{subscriptionId}/remove-scheduled-change": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "removeScheduledChange",
        "tags": [
          "Subscription"
        ],
        "summary": "Remove a scheduled plan or frequency change",
        "description": "Discards the scheduled End of Term or Specific Date plan or frequency change: stops its workflow, voids or credits its invoice, cancels the order and puts the pending renewal back on the current plan. Fails with 400 when nothing is scheduled.",
        "responses": {
          "200": {
            "description": "Scheduled change removed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "subscriptionId": {
                      "type": "string"
                    },
                    "cancelledOrderIds": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.removeScheduledChange"
      }
    },
    "/subscriptions/{subscriptionId}/remove-scheduled-pause": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "removeScheduledPause",
        "tags": [
          "Subscription"
        ],
        "summary": "Remove a scheduled pause",
        "description": "Removes a Specific Date pause that has not taken effect yet: stops the pause workflow and cancels the pause order. The subscription stays Active. Fails with 400 when no pause is scheduled.",
        "responses": {
          "200": {
            "description": "Scheduled pause removed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "subscriptionId": {
                      "type": "string"
                    },
                    "cancelledOrderId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.removeScheduledPause"
      }
    },
    "/subscriptions/{subscriptionId}/renew": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "renewSubscription",
        "tags": [
          "Subscription"
        ],
        "summary": "Renew a subscription",
        "description": "Creates a renewal order for an active subscription. Creates a scheduled renewal order for the subscription. Only ACTIVE or NON_RENEWING subscriptions can be renewed. The order is scheduled for termEndDate + 1 day.",
        "responses": {
          "200": {
            "description": "Renewal order created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "orderId": {
                      "type": "string"
                    },
                    "subscriptionId": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "eventType": {
                      "type": "string"
                    },
                    "scheduleDate": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "srcSysCode": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "required": false,
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.renewSubscription"
      }
    },
    "/subscriptions/{id}/resume": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "resumeSubscription",
        "tags": [
          "Subscription"
        ],
        "summary": "Resume a subscription",
        "description": "Resumes a paused subscription. Creates a resume order and starts the Camunda resume workflow. Only PAUSED subscriptions can be resumed.",
        "responses": {
          "200": {
            "description": "Subscription resumed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscription"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResumeSubscription"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.resumeSubscription"
      }
    },
    "/subscriptions/{subscriptionId}/terms": {
      "get": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "getSubscriptionTerms",
        "tags": [
          "Subscription"
        ],
        "summary": "Get subscription terms",
        "description": "Retrieves all subscription terms with latest version for a subscription ID.",
        "responses": {
          "200": {
            "description": "Array of subscription terms",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SubscriptionTerm"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionTerm.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionController.getSubscriptionTerms"
      }
    },
    "/subscriptions/{id}/transactions": {
      "get": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "findBySubscription",
        "tags": [
          "Transaction"
        ],
        "summary": "List a subscription's transactions",
        "description": "Retrieves the transactions applied to the subscription's invoices. A transaction is linked to a subscription through the invoices it paid.",
        "responses": {
          "200": {
            "description": "Transactions applied to the subscription invoices",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionsWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transaction.Filter"
                }
              }
            }
          }
        ],
        "operationId": "TransactionController.findBySubscription"
      }
    },
    "/subscriptions/{id}": {
      "get": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "findById",
        "tags": [
          "Subscription"
        ],
        "summary": "Fetch a subscription",
        "description": "Retrieves the details of the subscription. You can use the unique identifier to retrieve the desired details.",
        "responses": {
          "200": {
            "description": "Subscription model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionView"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionController.findById"
      },
      "delete": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "deleteById",
        "tags": [
          "Subscription"
        ],
        "summary": "Delete a subscription",
        "description": "Permanently deletes a subscription from the system. This is an administrative operation and should be used with caution.",
        "responses": {
          "204": {
            "description": "Subscription DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionController.deleteById"
      }
    },
    "/subscriptions": {
      "get": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "find",
        "tags": [
          "Subscription"
        ],
        "summary": "List subscriptions",
        "description": "Retrieves a list of subscriptions added.",
        "responses": {
          "200": {
            "description": "Subscription model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscriptions"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscription.Filter"
                }
              }
            }
          }
        ],
        "operationId": "SubscriptionController.find"
      }
    },
    "/tax-profiles/{id}/usage": {
      "get": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "usage",
        "tags": [
          "Taxation"
        ],
        "summary": "Where a tax profile is used",
        "responses": {
          "200": {
            "description": "Counts of prices and live subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "TaxationController.usage"
      }
    },
    "/tax-profiles/{id}": {
      "patch": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "updateById",
        "tags": [
          "Taxation"
        ],
        "summary": "Update a tax profile",
        "responses": {
          "204": {
            "description": "Tax profile updated"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "description": "Tax profile fields (id, tenantId are set by the server).",
          "x-parameter-index": 1
        },
        "operationId": "TaxationController.updateById"
      },
      "get": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "findById",
        "tags": [
          "Taxation"
        ],
        "summary": "Fetch a tax profile",
        "responses": {
          "200": {
            "description": "The tax profile",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "TaxationController.findById"
      },
      "delete": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "deleteById",
        "tags": [
          "Taxation"
        ],
        "summary": "Delete a tax profile",
        "responses": {
          "204": {
            "description": "Tax profile deleted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "TaxationController.deleteById"
      }
    },
    "/tax-profiles": {
      "post": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "create",
        "tags": [
          "Taxation"
        ],
        "summary": "Create a tax profile",
        "responses": {
          "200": {
            "description": "The new tax profile",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "description": "Tax profile fields (id, tenantId, status are set by the server)."
        },
        "operationId": "TaxationController.create"
      },
      "get": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "find",
        "tags": [
          "Taxation"
        ],
        "summary": "List tax profiles",
        "responses": {
          "200": {
            "description": "Array of tax profiles",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "region",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "TaxationController.find"
      }
    },
    "/taxation/{region}/calculation": {
      "put": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "setCalculation",
        "tags": [
          "Taxation"
        ],
        "summary": "Switch tax calculation",
        "description": "Turns BillHive tax calculation on or off for a region. Turning it on needs a valid GSTIN and creates a default profile when there is none.",
        "responses": {
          "204": {
            "description": "Calculation updated"
          }
        },
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "calculation"
                ],
                "properties": {
                  "calculation": {
                    "type": "string",
                    "enum": [
                      "BILLHIVE",
                      "NONE"
                    ]
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TaxationController.setCalculation"
      }
    },
    "/taxation/{region}": {
      "get": {
        "x-controller-name": "TaxationController",
        "x-operation-name": "summary",
        "tags": [
          "Taxation"
        ],
        "summary": "Taxation summary",
        "description": "The tenant's tax calculation switch, registration (from the business profile), pricing mode, tax profiles and setup issues for a region.",
        "responses": {
          "200": {
            "description": "TaxationSummary",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "TaxationController.summary"
      }
    },
    "/templates/getPreSignedUrl": {
      "post": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "generatePreSignedUrl",
        "tags": [
          "Template"
        ],
        "summary": "Generate pre-signed URL",
        "description": "Generates a pre-signed URL for uploading or downloading template assets such as images, attachments, or other media files used in email/notification templates.",
        "responses": {
          "200": {
            "description": "Pre-signed URL generated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        },
        "operationId": "TemplateController.generatePreSignedUrl"
      }
    },
    "/templates/{id}/select": {
      "patch": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "selectTemplate",
        "tags": [
          "Template"
        ],
        "summary": "Select a template",
        "description": "Selects a template as the active template for its category and type. Deselects any previously selected template of the same category and type.",
        "responses": {
          "204": {
            "description": "Template SELECT success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "templateSource": {
                    "type": "string"
                  }
                },
                "required": [
                  "templateSource"
                ]
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TemplateController.selectTemplate"
      }
    },
    "/templates/{id}": {
      "patch": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "updateById",
        "tags": [
          "Template"
        ],
        "summary": "Update a template",
        "description": "Updates an existing email or notification template. Partial updates are supported, allowing you to modify specific template fields without affecting others.",
        "responses": {
          "204": {
            "description": "Template PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TemplateViewPartialExcluding_templateId_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TemplateController.updateById"
      },
      "get": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "findById",
        "tags": [
          "Template"
        ],
        "summary": "Fetch a template",
        "description": "Retrieves the details of a specific email or notification template by its unique identifier. Use this to view template content, configuration, and metadata.",
        "responses": {
          "200": {
            "description": "Template model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateViewWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "TemplateController.findById"
      },
      "delete": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "deleteById",
        "tags": [
          "Template"
        ],
        "summary": "Delete a template",
        "description": "Permanently deletes an email or notification template by its unique identifier. This action cannot be undone.",
        "responses": {
          "204": {
            "description": "Template DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "TemplateController.deleteById"
      }
    },
    "/templates": {
      "post": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "login",
        "tags": [
          "Template"
        ],
        "summary": "Create a template",
        "description": "Creates a new email or notification template for the tenant. Templates can be used for emails, SMS, or other notification types.",
        "responses": {
          "200": {
            "description": "Template model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateView"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewTemplate"
              }
            }
          }
        },
        "operationId": "TemplateController.login"
      },
      "get": {
        "x-controller-name": "TemplateController",
        "x-operation-name": "find",
        "tags": [
          "Template"
        ],
        "summary": "List templates",
        "description": "Retrieves all email and notification templates for the current tenant. Supports filtering and sorting to find specific templates.",
        "responses": {
          "200": {
            "description": "Array of Template model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TemplateViewWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "TemplateController.find"
      }
    },
    "/tenants/{tenantId}/mandates/{mandateId}": {
      "get": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "getMandateById",
        "tags": [
          "Payment"
        ],
        "summary": "Fetch local payment mandate by mandate ID",
        "description": "Retrieves the mandate record stored in the local payment schema by internal mandate ID. This is different from fetching mandate details from the payment gateway.",
        "responses": {
          "200": {
            "description": "Mandate record from the local payment mandate table",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "mandateId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentController.getMandateById"
      }
    },
    "/tenants/{tenantId}/pg/mandates/{pgMandateId}": {
      "get": {
        "x-controller-name": "PaymentController",
        "x-operation-name": "getPGMandate",
        "tags": [
          "Payment"
        ],
        "summary": "Fetch payment mandate",
        "description": "Retrieves the details of a specific payment mandate from the payment gateway. Mandates are used for recurring payment authorizations such as direct debits or standing instructions.",
        "responses": {
          "200": {
            "description": "Get mandate details from payment gateway",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "pgMandateId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PaymentController.getPGMandate"
      }
    },
    "/tenants/{id}": {
      "patch": {
        "x-controller-name": "TenantController",
        "x-operation-name": "updateById",
        "tags": [
          "Tenant"
        ],
        "summary": "Update a tenant",
        "description": "Updates the tenant resource. You can modify tenant details by providing the tenant ID and the fields you want to update.",
        "responses": {
          "204": {
            "description": "Tenant PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TenantPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TenantController.updateById"
      }
    },
    "/tenants/{tenantId}": {
      "get": {
        "x-controller-name": "PublicController",
        "x-operation-name": "findTenant",
        "tags": [
          "PublicController"
        ],
        "summary": "Fetch tenant information",
        "description": "Retrieves tenant details by tenant ID. This is a public endpoint that does not require authentication.",
        "responses": {
          "200": {
            "description": "Tenant model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantWithRelations"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PublicController.findTenant"
      }
    },
    "/themes/{id}/rate-plans/{ratePlanId}": {
      "post": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "upsertRatePlanToTheme",
        "tags": [
          "Theme"
        ],
        "summary": "Add or update rate plan configuration to theme",
        "description": "Adds or updates a rate plan configuration to a pricing table theme. This allows you to customize how specific rate plans are displayed in the pricing table, including visibility, ordering, and styling options. Only applicable for themes with category \"Pricing-Table\".",
        "responses": {
          "200": {
            "description": "Theme model instance with updated rate plan configuration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Theme"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PricingTableRatePlanConfig"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "ThemeConfigsController.upsertRatePlanToTheme"
      },
      "delete": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "deleteRatePlanFromTheme",
        "tags": [
          "Theme"
        ],
        "summary": "Remove rate plan configuration from theme",
        "description": "Removes a specific rate plan configuration from a pricing table theme. This will remove the customization settings for the rate plan but does not delete the rate plan itself. Only applicable for themes with category \"Pricing-Table\".",
        "responses": {
          "204": {
            "description": "Rate plan configuration deleted from theme successfully"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "ratePlanId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ThemeConfigsController.deleteRatePlanFromTheme"
      }
    },
    "/themes/{id}": {
      "patch": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "updateById",
        "tags": [
          "Theme"
        ],
        "summary": "Update a theme configuration",
        "description": "Updates an existing theme configuration by its unique identifier. You can modify theme properties such as colors, fonts, layout settings, and other customization options.",
        "responses": {
          "204": {
            "description": "Theme PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ThemePartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ThemeConfigsController.updateById"
      }
    },
    "/transactions/{id}/complete-refund": {
      "patch": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "completeRefund",
        "tags": [
          "Transaction"
        ],
        "summary": "Complete a manual refund",
        "description": "Completes a Refund transaction that is in Needs Attention (a refund with no gateway payment to refund against) once finance has paid it out. Stores the UTR as the transaction reference and the refund date as the transaction date, and sets the status to Success. Returns 400 if the transaction is not a refund in Needs Attention and 404 if it does not exist.",
        "responses": {
          "200": {
            "description": "The completed refund transaction",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transaction"
                }
              }
            }
          },
          "400": {
            "description": "Not a Refund in Needs Attention, or invalid utr/refundDate"
          },
          "404": {
            "description": "Transaction not found"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "utr",
                  "refundDate"
                ],
                "properties": {
                  "utr": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "refundDate": {
                    "type": "string",
                    "format": "date"
                  },
                  "notes": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TransactionController.completeRefund"
      }
    },
    "/transactions": {
      "post": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "create",
        "tags": [
          "Transaction"
        ],
        "summary": "Create a transaction",
        "description": "Creates a new offline transaction record. This endpoint allows you to manually record payment transactions that occur outside the system.",
        "responses": {
          "200": {
            "description": "Transaction model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transaction"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewTransaction"
              }
            }
          }
        },
        "operationId": "TransactionController.create"
      },
      "get": {
        "x-controller-name": "TransactionController",
        "x-operation-name": "find",
        "tags": [
          "Transaction"
        ],
        "summary": "List transactions",
        "description": "Retrieves a list of all transactions. Transactions represent payments received from customers, including both applied and unapplied amounts.",
        "responses": {
          "200": {
            "description": "Array of Transaction model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TransactionsWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transaction.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "TransactionController.find"
      }
    },
    "/trial-periods/{id}": {
      "patch": {
        "x-controller-name": "TrialPeriodController",
        "x-operation-name": "updateTrialPeriodById",
        "tags": [
          "TrialPeriod"
        ],
        "summary": "Update a trial period",
        "description": "Updates the details of an existing trial period. You can modify trial period settings such as duration, terms, or other configuration options for the specified trial period.",
        "responses": {
          "204": {
            "description": "Period PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PeriodPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "TrialPeriodController.updateTrialPeriodById"
      }
    },
    "/trial-periods": {
      "post": {
        "x-controller-name": "TrialPeriodController",
        "x-operation-name": "createTrialPeriod",
        "tags": [
          "TrialPeriod"
        ],
        "summary": "Create a trial period",
        "description": "Creates a new trial period option for the tenant. Trial periods allow customers to try the service for a specified duration before committing to a paid subscription. The trial period is automatically marked as opted and associated with the current tenant.",
        "responses": {
          "200": {
            "description": "Period model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPeriod"
              }
            }
          }
        },
        "operationId": "TrialPeriodController.createTrialPeriod"
      },
      "get": {
        "x-controller-name": "TrialPeriodController",
        "x-operation-name": "findTrialOptions",
        "tags": [
          "TrialPeriod"
        ],
        "summary": "List trial periods",
        "description": "Retrieves a list of trial period options configured for the tenant. Trial periods define the duration and terms for trial subscriptions available to customers.",
        "responses": {
          "200": {
            "description": "Array of Period model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PeriodWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Period.Filter"
                }
              }
            }
          }
        ],
        "operationId": "TrialPeriodController.findTrialOptions"
      }
    },
    "/usage-aggregations/compute": {
      "post": {
        "x-controller-name": "UsageController",
        "x-operation-name": "computeUsageAggregations",
        "tags": [
          "Usage"
        ],
        "summary": "Compute usage aggregations for a subscription",
        "description": "Triggers usage aggregation computation for a subscription. Finds all metered addon prices, aggregates usage events per the configured method, and creates/updates aggregation records.",
        "responses": {
          "200": {
            "description": "Computed aggregation results",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "computed": {
                      "type": "number"
                    },
                    "aggregations": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UsageAggregation"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "subscriptionId"
                ],
                "properties": {
                  "subscriptionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "billingPeriodStart": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "billingPeriodEnd": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            }
          }
        },
        "operationId": "UsageController.computeUsageAggregations"
      }
    },
    "/usage-aggregations/{id}": {
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageAggregationById",
        "tags": [
          "Usage"
        ],
        "summary": "Get a usage aggregation by ID",
        "responses": {
          "200": {
            "description": "UsageAggregation model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageAggregation"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "UsageController.findUsageAggregationById"
      }
    },
    "/usage-aggregations": {
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageAggregations",
        "tags": [
          "Usage"
        ],
        "summary": "List usage aggregations",
        "description": "Retrieves computed usage aggregation records. Aggregations represent the billing-ready totals for a subscription and addon price within a billing period.",
        "responses": {
          "200": {
            "description": "Array of UsageAggregation instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "usageAggregations": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UsageAggregation"
                      }
                    },
                    "totalCount": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageAggregation.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UsageController.findUsageAggregations"
      }
    },
    "/usage-event-batches/{id}": {
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageEventBatchById",
        "tags": [
          "Usage"
        ],
        "summary": "Get a batch by ID",
        "responses": {
          "200": {
            "description": "UsageEventBatch model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEventBatch"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "UsageController.findUsageEventBatchById"
      }
    },
    "/usage-event-batches": {
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageEventBatches",
        "tags": [
          "Usage"
        ],
        "summary": "List usage event batches",
        "description": "Retrieves batch import records with success/failure counts.",
        "responses": {
          "200": {
            "description": "Array of UsageEventBatch model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/UsageEventBatch"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEventBatch.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UsageController.findUsageEventBatches"
      }
    },
    "/usage-events/batch": {
      "post": {
        "x-controller-name": "UsageController",
        "x-operation-name": "createUsageEventBatch",
        "tags": [
          "Usage"
        ],
        "summary": "Ingest a batch of usage events",
        "description": "Ingests multiple usage events in a single request. Returns a batch summary with success/duplicate/failure counts.",
        "responses": {
          "200": {
            "description": "Batch ingestion result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEventBatch"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "events": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/BatchUsageEvent"
                    }
                  }
                },
                "required": [
                  "events"
                ]
              }
            }
          }
        },
        "operationId": "UsageController.createUsageEventBatch"
      }
    },
    "/usage-events/{id}": {
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageEventById",
        "tags": [
          "Usage"
        ],
        "summary": "Get a usage event by ID",
        "responses": {
          "200": {
            "description": "UsageEvent model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEvent"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "UsageController.findUsageEventById"
      },
      "delete": {
        "x-controller-name": "UsageController",
        "x-operation-name": "deleteUsageEventById",
        "tags": [
          "Usage"
        ],
        "summary": "Delete a usage event",
        "responses": {
          "204": {
            "description": "UsageEvent DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "UsageController.deleteUsageEventById"
      }
    },
    "/usage-events": {
      "post": {
        "x-controller-name": "UsageController",
        "x-operation-name": "createUsageEvent",
        "tags": [
          "Usage"
        ],
        "summary": "Ingest a single usage event",
        "description": "Ingests a schema-less usage event for usage-based billing. Events are deduplicated by eventId per tenant.",
        "responses": {
          "200": {
            "description": "UsageEvent model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEvent"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewUsageEvent"
              }
            }
          }
        },
        "operationId": "UsageController.createUsageEvent"
      },
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "findUsageEvents",
        "tags": [
          "Usage"
        ],
        "summary": "List usage events",
        "description": "Retrieves usage events with enriched subscription and account details. Supports filtering by event type, status, date range, and event properties.",
        "responses": {
          "200": {
            "description": "Array of UsageEvent model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEvents"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageEventView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UsageController.findUsageEvents"
      }
    },
    "/usages": {
      "post": {
        "x-controller-name": "UsageController",
        "x-operation-name": "create",
        "tags": [
          "Usage"
        ],
        "summary": "Create a usage record",
        "description": "Creates a usage record for metered billing. Usage records are used to track consumption-based charges for subscriptions with usage-based pricing models.<br><br>The usage data is recorded against a subscription and can be aggregated for billing purposes.",
        "responses": {
          "200": {
            "description": "Usage model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Usage"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewUsage"
              }
            }
          }
        },
        "operationId": "UsageController.create"
      },
      "get": {
        "x-controller-name": "UsageController",
        "x-operation-name": "find",
        "tags": [
          "Usage"
        ],
        "summary": "List usage records",
        "description": "Retrieves a list of usage records for metered billing. Usage records track consumption-based metrics for subscriptions and can be filtered by subscription, date range, or other criteria.",
        "responses": {
          "200": {
            "description": "Array of Usage model instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Usages"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageView.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UsageController.find"
      }
    },
    "/users/{emailId}": {
      "patch": {
        "x-controller-name": "UserController",
        "x-operation-name": "updateById",
        "tags": [
          "Access Management"
        ],
        "summary": "Update a user",
        "description": "Updates the user details for the specified email address.",
        "responses": {
          "204": {
            "description": "User PATCH success"
          }
        },
        "parameters": [
          {
            "name": "emailId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserPartial"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "UserController.updateById"
      },
      "delete": {
        "x-controller-name": "UserController",
        "x-operation-name": "deleteById",
        "tags": [
          "Access Management"
        ],
        "summary": "Delete a user",
        "description": "Deletes the user with the specified email address from the system.",
        "responses": {
          "204": {
            "description": "User DELETE success"
          }
        },
        "parameters": [
          {
            "name": "emailId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "UserController.deleteById"
      }
    },
    "/users/{email}": {
      "get": {
        "x-controller-name": "UserController",
        "x-operation-name": "findById",
        "tags": [
          "Access Management"
        ],
        "summary": "Fetch a user",
        "description": "Retrieves the details of the desired user. You can use the email address for a particular user to retrieve the desired details.",
        "responses": {
          "200": {
            "description": "User model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "email",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UserController.findById"
      }
    },
    "/users": {
      "post": {
        "x-controller-name": "UserController",
        "x-operation-name": "create",
        "tags": [
          "Access Management"
        ],
        "summary": "Create a user",
        "description": "Creates a user account in the system and Keycloak. The user has no password yet: Keycloak emails them a link to verify their email and set one. The transaction ensures the user is created in both the application and the identity provider.",
        "responses": {
          "200": {
            "description": "User model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewUser"
              }
            }
          }
        },
        "operationId": "UserController.create"
      },
      "get": {
        "x-controller-name": "UserController",
        "x-operation-name": "find",
        "tags": [
          "Access Management"
        ],
        "summary": "List users",
        "description": "Retrieves a list of users for the tenant.",
        "responses": {
          "200": {
            "description": "Array of User model instances",
            "content": {
              "application/json": {}
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User.Filter"
                }
              }
            }
          }
        ],
        "operationId": "UserController.find"
      }
    },
    "/v2/accounts/{id}/wallet": {
      "get": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "accountWallet",
        "tags": [
          "Wallet"
        ],
        "summary": "An account’s wallets",
        "description": "Each live subscription’s balance, the balance carried over on subscriptions that have ended, and the total.",
        "responses": {
          "200": {
            "description": "{subscriptions:[{id, balance}], carriedOver, total}"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "WalletV2Controller.accountWallet"
      }
    },
    "/v2/addon-prices/{id}": {
      "patch": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "updateAddonPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Update add-on price and replace its components",
        "responses": {
          "204": {
            "description": "PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.updateAddonPrice"
      },
      "delete": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "deleteAddonPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Delete add-on price and its components",
        "responses": {
          "204": {
            "description": "DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.deleteAddonPrice"
      }
    },
    "/v2/addons/{id}/prices": {
      "post": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "createAddonPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Create add-on price with components",
        "responses": {
          "200": {
            "description": "The created price point with its components"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.createAddonPrice"
      },
      "get": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "listAddonPrices",
        "tags": [
          "Price v2"
        ],
        "summary": "List add-on prices with components",
        "responses": {
          "200": {
            "description": "Price points, each with components[] and their tiers[]"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.listAddonPrices"
      }
    },
    "/v2/charge-prices/{id}": {
      "patch": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "updateChargePrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Update charge price and replace its components",
        "responses": {
          "204": {
            "description": "PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.updateChargePrice"
      },
      "delete": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "deleteChargePrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Delete charge price and its components",
        "responses": {
          "204": {
            "description": "DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.deleteChargePrice"
      }
    },
    "/v2/charges/{id}/prices": {
      "post": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "createChargePrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Create charge price with components",
        "responses": {
          "200": {
            "description": "The created price point with its components"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.createChargePrice"
      },
      "get": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "listChargePrices",
        "tags": [
          "Price v2"
        ],
        "summary": "List charge prices with components",
        "responses": {
          "200": {
            "description": "Price points, each with components[] and their tiers[]"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.listChargePrices"
      }
    },
    "/v2/prices/rate": {
      "post": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "rate",
        "tags": [
          "Price v2"
        ],
        "summary": "Rate components against inputs (preview)",
        "responses": {
          "200": {
            "description": "RatedLine[]"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  },
                  "inputs": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "defaults": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "commitment": {
                    "type": "object",
                    "nullable": true,
                    "properties": {
                      "amount": {
                        "type": "number"
                      },
                      "period": {
                        "type": "string"
                      }
                    }
                  },
                  "currency": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "operationId": "PriceV2Controller.rate"
      }
    },
    "/v2/rate-plan-prices/{id}/subscription-count": {
      "get": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "ratePlanPriceSubscriptionCount",
        "tags": [
          "Price v2"
        ],
        "summary": "Subscriptions with an active, non-cancelled and non-expired term on a rate plan price",
        "responses": {
          "200": {
            "description": "The count",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.ratePlanPriceSubscriptionCount"
      }
    },
    "/v2/rate-plan-prices/{id}": {
      "patch": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "updateRatePlanPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Update rate plan price and replace its components",
        "responses": {
          "200": {
            "description": "EXISTING_TOO: the subscriptions moved and skipped",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "applied": {
                      "type": "object",
                      "properties": {
                        "moved": {
                          "type": "number"
                        },
                        "skippedCustom": {
                          "type": "number"
                        },
                        "failed": {
                          "type": "number"
                        },
                        "failedSubscriptionIds": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "queued": {
                          "type": "number",
                          "description": "Subscribers being moved in the background (a price with more than 50)"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "204": {
            "description": "PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "applyTo",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.updateRatePlanPrice"
      },
      "delete": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "deleteRatePlanPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Delete rate plan price and its components",
        "responses": {
          "204": {
            "description": "DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.deleteRatePlanPrice"
      }
    },
    "/v2/rate-plans/{id}/prices": {
      "post": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "createRatePlanPrice",
        "tags": [
          "Price v2"
        ],
        "summary": "Create rate plan price with components",
        "responses": {
          "200": {
            "description": "The created price point with its components"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pricePoint": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PriceV2Controller.createRatePlanPrice"
      },
      "get": {
        "x-controller-name": "PriceV2Controller",
        "x-operation-name": "listRatePlanPrices",
        "tags": [
          "Price v2"
        ],
        "summary": "List rate plan prices with components",
        "responses": {
          "200": {
            "description": "Price points, each with components[] and their tiers[]"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "PriceV2Controller.listRatePlanPrices"
      }
    },
    "/v2/subscriptions/{id}/price/override": {
      "delete": {
        "x-controller-name": "SubscriptionPriceV2Controller",
        "x-operation-name": "remove",
        "tags": [
          "Subscription price v2"
        ],
        "summary": "Revert to the catalogue price from the next renewal",
        "responses": {
          "204": {
            "description": "DELETE success"
          },
          "403": {
            "description": "The PriceOverride setting is off"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionPriceV2Controller.remove"
      }
    },
    "/v2/subscriptions/{id}/price": {
      "put": {
        "x-controller-name": "SubscriptionPriceV2Controller",
        "x-operation-name": "put",
        "tags": [
          "Subscription price v2"
        ],
        "summary": "Override the subscription price (from the next renewal, or in the current term)",
        "responses": {
          "200": {
            "description": "{phases: [...]}"
          },
          "403": {
            "description": "The PriceOverride setting is off"
          },
          "409": {
            "description": "Another change to the subscription is running"
          },
          "422": {
            "description": "The components change the price structure"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  },
                  "commitment": {
                    "type": "object",
                    "nullable": true,
                    "properties": {
                      "amount": {
                        "type": "number"
                      },
                      "period": {
                        "type": "string"
                      }
                    }
                  },
                  "effective": {
                    "type": "string",
                    "enum": [
                      "NEXT_RENEWAL",
                      "CURRENT_TERM"
                    ]
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionPriceV2Controller.put"
      },
      "get": {
        "x-controller-name": "SubscriptionPriceV2Controller",
        "x-operation-name": "get",
        "tags": [
          "Subscription price v2"
        ],
        "summary": "The subscription price phase in force and the future ones, with components",
        "responses": {
          "200": {
            "description": "{phases: [{...phase, components, inForce}]}"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionPriceV2Controller.get"
      }
    },
    "/v2/subscriptions/{id}/ramp": {
      "put": {
        "x-controller-name": "SubscriptionPriceV2Controller",
        "x-operation-name": "putRamp",
        "tags": [
          "Subscription price v2"
        ],
        "summary": "Set the subscription ramp: a price per phase from term start dates, replacing the future phases",
        "responses": {
          "200": {
            "description": "{phases: [...]}"
          },
          "403": {
            "description": "The PriceOverride setting is off"
          },
          "422": {
            "description": "A start is not a term start date ({nearest: [before, after]}), or the components change the price structure"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "phases": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "startDate": {
                          "type": "string"
                        },
                        "startsAfterCycles": {
                          "type": "integer",
                          "minimum": 0
                        },
                        "components": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "additionalProperties": true
                          }
                        },
                        "commitment": {
                          "type": "object",
                          "nullable": true,
                          "properties": {
                            "amount": {
                              "type": "number"
                            },
                            "period": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionPriceV2Controller.putRamp"
      }
    },
    "/v2/subscriptions/{id}/wallet/adjustments": {
      "post": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "adjust",
        "tags": [
          "Wallet"
        ],
        "summary": "Add credits to a wallet",
        "description": "Posts an Adjustment memo for {amount > 0, reason}. It never expires. There is no negative adjustment: cancel an entry instead.",
        "responses": {
          "200": {
            "description": "The credit memo"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "WalletV2Controller.adjust"
      }
    },
    "/v2/subscriptions/{id}/wallet/entries/{memoId}": {
      "delete": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "cancelEntry",
        "tags": [
          "Wallet"
        ],
        "summary": "Remove a wallet entry’s remaining credits",
        "description": "Cancels the entry and zeroes its remaining balance; what was already spent stays spent.",
        "responses": {
          "200": {
            "description": "{removed}"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "memoId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "WalletV2Controller.cancelEntry"
      }
    },
    "/v2/subscriptions/{id}/wallet/top-ups": {
      "post": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "topUp",
        "tags": [
          "Wallet"
        ],
        "summary": "Buy wallet credits",
        "description": "Either {packIndex} for one of the current price’s credit packs, or {amount} for a custom top-up (no bonus). Raises a WALLET TOP-UP order with one taxed line and its invoice; the credits are posted when it is paid. 422 for a currency mismatch, an invalid amount, or a packIndex on a price with no packs.",
        "responses": {
          "200": {
            "description": "The order, its invoice and the payment session"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "WalletV2Controller.topUp"
      }
    },
    "/v2/subscriptions/{id}/wallet": {
      "get": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "subscriptionWallet",
        "tags": [
          "Wallet"
        ],
        "summary": "A subscription’s wallet",
        "description": "The usable balance, the projected balance (balance less this term’s unbilled usage and pending charges on components paid from credits), walletExhausted (a BLOCK price whose projected balance reached 0 at the last check), projectedUnavailable (set when the usage could not be computed; projected is then the balance), every wallet entry newest first, and the entries that will expire.",
        "responses": {
          "200": {
            "description": "{balance, projected, walletExhausted, entries, upcomingExpiries}"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "WalletV2Controller.subscriptionWallet"
      }
    },
    "/v2/wallet/top-ups/{invoiceId}/reverse": {
      "post": {
        "x-controller-name": "WalletV2Controller",
        "x-operation-name": "reverse",
        "tags": [
          "Wallet"
        ],
        "summary": "Reverse a refunded or charged-back top-up",
        "description": "No gateway refund or chargeback webhook reaches the wallet, so the merchant calls this. The unspent credits of the top-up and its bonus are removed; the part already spent is billed back as a \"Credits reversed\" pending charge. Calling it again changes nothing.",
        "responses": {
          "200": {
            "description": "{removed, charged, alreadyReversed}"
          }
        },
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "WalletV2Controller.reverse"
      }
    },
    "/webhooks/{id}": {
      "patch": {
        "x-controller-name": "WebhookController",
        "x-operation-name": "updateById",
        "tags": [
          "Webhook"
        ],
        "summary": "Update webhook",
        "description": "Updates the configuration of a specific webhook endpoint. You can modify the URL, event types, or status of the webhook.",
        "responses": {
          "204": {
            "description": "Webhook PATCH success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookPartialExcluding_id_"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "WebhookController.updateById"
      },
      "get": {
        "x-controller-name": "WebhookController",
        "x-operation-name": "findById",
        "tags": [
          "Webhook"
        ],
        "summary": "Fetch a webhook",
        "description": "Retrieves the details of a specific webhook endpoint using its unique identifier.",
        "responses": {
          "200": {
            "description": "Webhook model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook.Filter"
                }
              }
            }
          }
        ],
        "operationId": "WebhookController.findById"
      },
      "delete": {
        "x-controller-name": "WebhookController",
        "x-operation-name": "deleteById",
        "tags": [
          "Webhook"
        ],
        "summary": "Delete webhook",
        "description": "Deletes a specific webhook endpoint. This action is permanent and cannot be undone.",
        "responses": {
          "204": {
            "description": "Webhook DELETE success"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "WebhookController.deleteById"
      }
    },
    "/webhooks": {
      "post": {
        "x-controller-name": "WebhookController",
        "x-operation-name": "create",
        "tags": [
          "Webhook"
        ],
        "summary": "Create webhook",
        "description": "Creates a webhook endpoint for receiving event notifications. The webhook will be active upon creation and will receive events based on configured event types.",
        "responses": {
          "200": {
            "description": "Webhook model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewWebhook"
              }
            }
          }
        },
        "operationId": "WebhookController.create"
      },
      "get": {
        "x-controller-name": "WebhookController",
        "x-operation-name": "find",
        "tags": [
          "Webhook"
        ],
        "summary": "List webhooks",
        "description": "Retrieves a list of all webhook endpoints configured for the tenant.",
        "responses": {
          "200": {
            "description": "Array of Webhook model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WebhooksWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook.Filter1"
                }
              }
            }
          }
        ],
        "operationId": "WebhookController.find"
      }
    },
    "/whoami": {
      "get": {
        "x-controller-name": "AuthController",
        "x-operation-name": "whoami",
        "tags": [
          "Auth"
        ],
        "summary": "Get current user",
        "description": "Retrieves the profile information of the currently authenticated user based on the JWT token.",
        "responses": {
          "200": {
            "description": "User model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        },
        "operationId": "AuthController.whoami"
      }
    },
    "/workflow/skip": {
      "post": {
        "x-controller-name": "WorkflowController",
        "x-operation-name": "skipWorkflow",
        "tags": [
          "Workflow"
        ],
        "summary": "Execute workflow skip",
        "description": "Marks the tenant onboarding workflow automation as skipped, bypassing the standard onboarding process. This endpoint allows users to skip the onboarding flow entirely when they choose not to complete the workflow steps. The operation updates the workflow state to indicate it has been intentionally skipped and records the timestamp. Use this when a user wants to proceed without completing the onboarding workflow.",
        "responses": {
          "200": {
            "description": "Onboarding workflow skipped successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "isFlowSkipped": {
                          "type": "boolean"
                        },
                        "isFlowCompleted": {
                          "type": "boolean"
                        },
                        "skippedAt": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "operationId": "WorkflowController.skipWorkflow"
      }
    },
    "/workflow/status": {
      "get": {
        "x-controller-name": "WorkflowController",
        "x-operation-name": "getStatus",
        "tags": [
          "Workflow"
        ],
        "summary": "Fetch workflow status",
        "description": "Retrieves the current status of the tenant onboarding workflow automation, including completed steps and progress tracking. This endpoint provides comprehensive information about the workflow execution state, whether it has been completed or skipped, and detailed step-by-step completion status. Use this to monitor and track the onboarding process for a tenant.",
        "responses": {
          "200": {
            "description": "Onboarding workflow status retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "isFlowCompleted": {
                          "type": "boolean"
                        },
                        "isFlowSkipped": {
                          "type": "boolean"
                        },
                        "completedAt": {
                          "type": "string",
                          "nullable": true
                        },
                        "steps": {
                          "type": "object"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "WorkflowController.getStatus"
      }
    },
    "/{tenantId}/accounts": {
      "post": {
        "x-controller-name": "PublicController",
        "x-operation-name": "create",
        "tags": [
          "PublicController"
        ],
        "summary": "Create a customer account (Public)",
        "description": "Public endpoint to create a customer account with an optional sold-to contact. contactPerson represents sold-to contact.<br><br>This is a public API that does not require authentication, typically used for self-service registration or checkout flows.<br><br>The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "Account model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/New1AccountInfo"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "PublicController.create"
      }
    },
    "/{accountId}/invoices/generate": {
      "get": {
        "x-controller-name": "InvoiceController",
        "x-operation-name": "generate",
        "tags": [
          "Invoice"
        ],
        "summary": "Generate invoice for customer",
        "description": "Initiates invoice generation process for a specific customer account. This creates invoices based on active subscriptions and pending charges.",
        "responses": {
          "200": {
            "description": "Array of Invoice model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/InvoiceWithRelations"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "InvoiceController.generate"
      }
    },
    "/{accountId}/subscriptions/orders/{orderId}/retry": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "retrySubscriptionOrder",
        "tags": [
          "Subscription"
        ],
        "summary": "Retry a failed subscription order",
        "description": "Restarts the Camunda workflow for a failed or stale subscription order.",
        "responses": {
          "200": {
            "description": "Order with new workflow instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "orderId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "SubscriptionController.retrySubscriptionOrder"
      }
    },
    "/{accountId}/subscriptions/{subscriptionId}/addons/recommended": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "addRecommendedAddons",
        "tags": [
          "Subscription"
        ],
        "summary": "Add recommended addons to subscription",
        "description": "Creates an add addon order and starts the Camunda add-addon workflow.",
        "responses": {
          "200": {
            "description": "Order details with add addon status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddAddonOrder"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionController.addRecommendedAddons"
      }
    },
    "/{accountId}/subscriptions/{subscriptionId}/change-frequency": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "changeFrequency",
        "tags": [
          "Subscription"
        ],
        "summary": "Change frequency for a subscription",
        "description": "Creates a change frequency order and starts the Camunda change-frequency workflow.",
        "responses": {
          "200": {
            "description": "Order details with change frequency status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangeFrequencyOrder"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionController.changeFrequency"
      }
    },
    "/{accountId}/subscriptions/{subscriptionId}/change-plan": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "changePlan",
        "tags": [
          "Subscription"
        ],
        "summary": "Change plan for a subscription",
        "description": "Creates a change plan order and starts the Camunda change-plan workflow.",
        "responses": {
          "200": {
            "description": "Order details with change plan status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChangePlanOrder"
              }
            }
          },
          "x-parameter-index": 2
        },
        "operationId": "SubscriptionController.changePlan"
      }
    },
    "/{accountId}/subscriptions": {
      "post": {
        "x-controller-name": "SubscriptionController",
        "x-operation-name": "create",
        "tags": [
          "Subscription"
        ],
        "summary": "Create a subscription",
        "description": "Creates a new subscription for an account. The transaction is atomic; if any part fails, the entire transaction is rolled back.",
        "responses": {
          "200": {
            "description": "Order details with subscription creation status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetails"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewSubscriptionOrder"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "SubscriptionController.create"
      }
    },
    "/{productId}/themes/{category}": {
      "get": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "findByProductIdCategory",
        "tags": [
          "Theme"
        ],
        "summary": "Fetch theme by product and category",
        "description": "Retrieves a theme configuration for a specific product and category. The category determines the type of theme (e.g., Pricing-Table, Checkout, Customer-Portal). Use this to get the active theme settings for a particular use case.",
        "responses": {
          "200": {
            "description": "Theme model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Theme"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "category",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ThemeConfigsController.findByProductIdCategory"
      }
    },
    "/{productId}/themes": {
      "post": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "createTheme",
        "tags": [
          "Theme"
        ],
        "summary": "Create a theme configuration",
        "description": "Creates a new theme configuration for a specific product. Themes can be used to customize the appearance and behavior of pricing tables, checkout pages, and other customer-facing interfaces.",
        "responses": {
          "200": {
            "description": "Theme model instance",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Theme"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewThemeConfig"
              }
            }
          },
          "x-parameter-index": 1
        },
        "operationId": "ThemeConfigsController.createTheme"
      },
      "get": {
        "x-controller-name": "ThemeConfigsController",
        "x-operation-name": "findByProductId",
        "tags": [
          "Theme"
        ],
        "summary": "List all themes for a product",
        "description": "Retrieves all theme configurations associated with a specific product. This includes themes for all categories such as pricing tables, checkout pages, and customer portals.",
        "responses": {
          "200": {
            "description": "Array of Theme model instances",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Theme"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "operationId": "ThemeConfigsController.findByProductId"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    },
    "schemas": {
      "Webhook": {
        "title": "Webhook",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "endpointUrl": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": false,
              "enum": [
                "Subscription Activated",
                "Subscription Renewed",
                "Subscription Paused",
                "Subscription Resumed",
                "Subscription Cancelled",
                "Subscription Expired",
                "Subscription Changed",
                "Trial Subscription",
                "Subscription Created",
                "Subscription Trial Ending Soon",
                "Subscription Scheduled Cancellation",
                "Subscription Scheduled Change",
                "Subscription Expiring Soon",
                "Invoice Created",
                "Invoice Paid",
                "Invoice Overdue",
                "Invoice Due Soon",
                "Payment Successful",
                "Payment Failed",
                "Payment Retry Attempt",
                "Payment Final Failure",
                "Refund Issued",
                "Credit Note Issued",
                "Payment Method Expiring",
                "Payment Method Expired",
                "Payment Method Updated",
                "Payment Method Missing",
                "Payment Request Created",
                "Auto Debit Reminder",
                "Post Cancellation"
              ]
            }
          }
        },
        "required": [
          "tenantId",
          "endpointUrl",
          "status",
          "createdAt",
          "eventTypes"
        ],
        "additionalProperties": false
      },
      "NewWebhook": {
        "title": "NewWebhook",
        "type": "object",
        "description": "(tsType: Omit<Webhook, 'webhookId' | 'status' | 'tenantId' | 'createdAt'>, schemaOptions: { title: 'NewWebhook', exclude: [ 'webhookId', 'status', 'tenantId', 'createdAt' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "endpointUrl": {
            "type": "string",
            "nullable": false
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": false,
              "enum": [
                "Subscription Activated",
                "Subscription Renewed",
                "Subscription Paused",
                "Subscription Resumed",
                "Subscription Cancelled",
                "Subscription Expired",
                "Subscription Changed",
                "Trial Subscription",
                "Subscription Created",
                "Subscription Trial Ending Soon",
                "Subscription Scheduled Cancellation",
                "Subscription Scheduled Change",
                "Subscription Expiring Soon",
                "Invoice Created",
                "Invoice Paid",
                "Invoice Overdue",
                "Invoice Due Soon",
                "Payment Successful",
                "Payment Failed",
                "Payment Retry Attempt",
                "Payment Final Failure",
                "Refund Issued",
                "Credit Note Issued",
                "Payment Method Expiring",
                "Payment Method Expired",
                "Payment Method Updated",
                "Payment Method Missing",
                "Payment Request Created",
                "Auto Debit Reminder",
                "Post Cancellation"
              ]
            }
          }
        },
        "required": [
          "endpointUrl",
          "eventTypes"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Webhook, 'webhookId' | 'status' | 'tenantId' | 'createdAt'>"
      },
      "WebhooksWithRelations": {
        "title": "WebhooksWithRelations",
        "type": "object",
        "description": "(tsType: WebhooksWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "webhooks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Webhook"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "WebhooksWithRelations"
      },
      "WebhookPartialExcluding_id_": {
        "title": "WebhookPartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Webhook>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "endpointUrl": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": false,
              "enum": [
                "Subscription Activated",
                "Subscription Renewed",
                "Subscription Paused",
                "Subscription Resumed",
                "Subscription Cancelled",
                "Subscription Expired",
                "Subscription Changed",
                "Trial Subscription",
                "Subscription Created",
                "Subscription Trial Ending Soon",
                "Subscription Scheduled Cancellation",
                "Subscription Scheduled Change",
                "Subscription Expiring Soon",
                "Invoice Created",
                "Invoice Paid",
                "Invoice Overdue",
                "Invoice Due Soon",
                "Payment Successful",
                "Payment Failed",
                "Payment Retry Attempt",
                "Payment Final Failure",
                "Refund Issued",
                "Credit Note Issued",
                "Payment Method Expiring",
                "Payment Method Expired",
                "Payment Method Updated",
                "Payment Method Missing",
                "Payment Request Created",
                "Auto Debit Reminder",
                "Post Cancellation"
              ]
            }
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Webhook>, 'id'>"
      },
      "User": {
        "title": "User",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Suspended",
              "Deleted"
            ]
          },
          "id": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "keycloakId": {
            "type": "string"
          },
          "dailyDigest": {
            "type": "boolean"
          }
        },
        "required": [
          "firstName",
          "email",
          "roles"
        ],
        "additionalProperties": false
      },
      "NewUser": {
        "title": "NewUser",
        "type": "object",
        "description": "(tsType: Omit<User, 'userId' | 'refreshToken' | 'status' | 'password' | 'keycloakId'>, schemaOptions: { title: 'NewUser', exclude: [ 'userId', 'refreshToken', 'status', 'password', 'keycloakId' ] })",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "dailyDigest": {
            "type": "boolean"
          }
        },
        "required": [
          "firstName",
          "email",
          "roles"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<User, 'userId' | 'refreshToken' | 'status' | 'password' | 'keycloakId'>"
      },
      "UserPartial": {
        "title": "UserPartial",
        "type": "object",
        "description": "(tsType: Partial<User>, schemaOptions: { partial: true })",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Suspended",
              "Deleted"
            ]
          },
          "id": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "keycloakId": {
            "type": "string"
          },
          "dailyDigest": {
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<User>"
      },
      "Usage": {
        "title": "Usage",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "termSubscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "postedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "addonPriceId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "SYSTEM",
              "MANUAL",
              "IMPORT"
            ]
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "ACTIVE",
              "LATE",
              "INVALID"
            ]
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "appliedTo": {
            "type": "string",
            "nullable": false,
            "enum": [
              "INVOICE",
              "DEBIT MEMO",
              "PENDING"
            ]
          }
        },
        "required": [
          "accountId",
          "termSubscriptionId",
          "quantity",
          "tenantId",
          "addonPriceId",
          "source",
          "status",
          "subscriptionId",
          "appliedTo"
        ],
        "additionalProperties": false
      },
      "NewUsage": {
        "title": "NewUsage",
        "type": "object",
        "description": "(tsType: Omit<Usage, 'usageId' | 'tenantId' | 'createdTs' | 'status' | 'appliedTo'>, schemaOptions: { title: 'NewUsage', exclude: [ 'usageId', 'tenantId', 'createdTs', 'status', 'appliedTo' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "termSubscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "postedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": false
          },
          "addonPriceId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "SYSTEM",
              "MANUAL",
              "IMPORT"
            ]
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          }
        },
        "required": [
          "accountId",
          "termSubscriptionId",
          "quantity",
          "addonPriceId",
          "source",
          "subscriptionId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Usage, 'usageId' | 'tenantId' | 'createdTs' | 'status' | 'appliedTo'>"
      },
      "Usages": {
        "title": "Usages",
        "type": "object",
        "properties": {
          "usages": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "UsageEvent": {
        "title": "UsageEvent",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "eventId": {
            "type": "string",
            "nullable": false
          },
          "eventType": {
            "type": "string",
            "nullable": false
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "eventTimestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "properties": {
            "type": "object",
            "nullable": false
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "API",
              "BATCH_API",
              "CSV_IMPORT",
              "MANUAL"
            ]
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "PENDING",
              "PROCESSED",
              "INVALID",
              "DUPLICATE"
            ]
          }
        },
        "required": [
          "eventId",
          "eventType",
          "subscriptionId",
          "accountId",
          "tenantId",
          "eventTimestamp",
          "source",
          "status"
        ],
        "additionalProperties": false
      },
      "NewUsageEvent": {
        "title": "NewUsageEvent",
        "type": "object",
        "description": "(tsType: Omit<UsageEvent, 'id' | 'status' | 'createdAt' | 'tenantId'>, schemaOptions: { title: 'NewUsageEvent', exclude: [ 'id', 'status', 'createdAt', 'tenantId' ] })",
        "properties": {
          "eventId": {
            "type": "string",
            "nullable": false
          },
          "eventType": {
            "type": "string",
            "nullable": false
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "eventTimestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "properties": {
            "type": "object",
            "nullable": false
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "API",
              "BATCH_API",
              "CSV_IMPORT",
              "MANUAL"
            ]
          }
        },
        "required": [
          "eventId",
          "eventType",
          "subscriptionId",
          "accountId",
          "eventTimestamp",
          "source"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<UsageEvent, 'id' | 'status' | 'createdAt' | 'tenantId'>"
      },
      "UsageEventBatch": {
        "title": "UsageEventBatch",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "API",
              "BATCH_API",
              "CSV_IMPORT",
              "MANUAL"
            ]
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "totalEvents": {
            "type": "number",
            "nullable": false
          },
          "successCount": {
            "type": "number",
            "nullable": false
          },
          "failureCount": {
            "type": "number",
            "nullable": false
          },
          "duplicateCount": {
            "type": "number",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false
          },
          "errorDetails": {
            "type": "object",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "required": [
          "tenantId",
          "source"
        ],
        "additionalProperties": false
      },
      "BatchUsageEvent": {
        "title": "BatchUsageEvent",
        "type": "object",
        "description": "(tsType: Omit<UsageEvent, 'id' | 'status' | 'createdAt' | 'tenantId'>, schemaOptions: { title: 'BatchUsageEvent', exclude: [ 'id', 'status', 'createdAt', 'tenantId' ] })",
        "properties": {
          "eventId": {
            "type": "string",
            "nullable": false
          },
          "eventType": {
            "type": "string",
            "nullable": false
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "eventTimestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "properties": {
            "type": "object",
            "nullable": false
          },
          "source": {
            "type": "string",
            "nullable": false,
            "enum": [
              "API",
              "BATCH_API",
              "CSV_IMPORT",
              "MANUAL"
            ]
          }
        },
        "required": [
          "eventId",
          "eventType",
          "subscriptionId",
          "accountId",
          "eventTimestamp",
          "source"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<UsageEvent, 'id' | 'status' | 'createdAt' | 'tenantId'>"
      },
      "UsageEvents": {
        "title": "UsageEvents",
        "type": "object",
        "properties": {
          "usageEvents": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "UsageAggregation": {
        "title": "UsageAggregation",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "addonPriceId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "billingPeriodStart": {
            "type": "string",
            "format": "date-time"
          },
          "billingPeriodEnd": {
            "type": "string",
            "format": "date-time"
          },
          "rawQuantity": {
            "type": "number",
            "nullable": false
          },
          "includedQuantity": {
            "type": "number",
            "nullable": false
          },
          "billableQuantity": {
            "type": "number",
            "nullable": false
          },
          "amount": {
            "type": "number",
            "nullable": false
          },
          "invoiceId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "orderId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "priceComponentId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "required": [
          "tenantId",
          "subscriptionId",
          "billingPeriodStart",
          "billingPeriodEnd",
          "rawQuantity",
          "includedQuantity",
          "billableQuantity",
          "amount"
        ],
        "additionalProperties": false
      },
      "PeriodWithRelations": {
        "title": "PeriodWithRelations",
        "type": "object",
        "description": "(tsType: PeriodWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "periodName": {
            "type": "string",
            "nullable": false
          },
          "term": {
            "type": "number",
            "nullable": false
          },
          "period": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Day",
              "Week",
              "Month",
              "Year"
            ]
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "isOpted": {
            "type": "boolean",
            "nullable": false
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "integer",
            "nullable": false,
            "minimum": 1
          }
        },
        "required": [
          "periodName",
          "term",
          "period",
          "tenantId",
          "isOpted",
          "isTrial"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PeriodWithRelations"
      },
      "Period": {
        "title": "Period",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "periodName": {
            "type": "string",
            "nullable": false
          },
          "term": {
            "type": "number",
            "nullable": false
          },
          "period": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Day",
              "Week",
              "Month",
              "Year"
            ]
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "isOpted": {
            "type": "boolean",
            "nullable": false
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "integer",
            "nullable": false,
            "minimum": 1
          }
        },
        "required": [
          "periodName",
          "term",
          "period",
          "tenantId",
          "isOpted",
          "isTrial"
        ],
        "additionalProperties": false
      },
      "NewPeriod": {
        "title": "NewPeriod",
        "type": "object",
        "description": "(tsType: Omit<Period, 'id' | 'tenantId' | 'isOpted' | 'isTrial'>, schemaOptions: { title: 'NewPeriod', exclude: [ 'id', 'tenantId', 'isOpted', 'isTrial' ] })",
        "properties": {
          "periodName": {
            "type": "string",
            "nullable": false
          },
          "term": {
            "type": "number",
            "nullable": false
          },
          "period": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Day",
              "Week",
              "Month",
              "Year"
            ]
          },
          "termLength": {
            "type": "integer",
            "nullable": false,
            "minimum": 1
          }
        },
        "required": [
          "periodName",
          "term",
          "period"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Period, 'id' | 'tenantId' | 'isOpted' | 'isTrial'>"
      },
      "PeriodPartial": {
        "title": "PeriodPartial",
        "type": "object",
        "description": "(tsType: Partial<Period>, schemaOptions: { partial: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "periodName": {
            "type": "string",
            "nullable": false
          },
          "term": {
            "type": "number",
            "nullable": false
          },
          "period": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Day",
              "Week",
              "Month",
              "Year"
            ]
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "isOpted": {
            "type": "boolean",
            "nullable": false
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "integer",
            "nullable": false,
            "minimum": 1
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<Period>"
      },
      "Transaction": {
        "title": "Transaction",
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "format": "uuid"
          },
          "referenceId": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "enum": [
              "Transaction",
              "Refund"
            ]
          },
          "mode": {
            "type": "string",
            "enum": [
              "Cash",
              "Cheque",
              "Credit Card",
              "Debit Card",
              "Bank Transfer",
              "Online Payment",
              "Mobile Payment",
              "Electronic Funds Transfer (EFT)",
              "UPI",
              "PhonePe",
              "Amazon",
              "Paytm",
              "FreeCharge",
              "MobikWik",
              "Net Banking",
              "Upi Autopay",
              "ENACH"
            ]
          },
          "accountName": {
            "type": "string"
          },
          "createdOn": {
            "type": "string",
            "format": "date-time"
          },
          "tenantId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Success",
              "Voided",
              "Failure",
              "Timeout",
              "Unknown",
              "In-Progress",
              "Needs Attention"
            ]
          },
          "reason": {
            "type": "string"
          },
          "appliedAmount": {
            "type": "number"
          },
          "unappliedAmount": {
            "type": "number"
          },
          "transactionDate": {
            "type": "string",
            "format": "date"
          },
          "gatewayId": {
            "type": "string"
          },
          "methodId": {
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "accountId",
          "type",
          "mode",
          "tenantId",
          "status",
          "appliedAmount",
          "unappliedAmount",
          "transactionDate"
        ],
        "additionalProperties": false
      },
      "NewTransaction": {
        "title": "NewTransaction",
        "type": "object",
        "description": "(tsType: Omit<Transaction, 'transactionId' | 'tenantId' | 'status' | 'appliedAmount' | 'unappliedAmount' | 'createdOn'>, schemaOptions: { title: 'NewTransaction', exclude: [ 'transactionId', 'tenantId', 'status', 'appliedAmount', 'unappliedAmount', 'createdOn' ] })",
        "properties": {
          "referenceId": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "enum": [
              "Transaction",
              "Refund"
            ]
          },
          "mode": {
            "type": "string",
            "enum": [
              "Cash",
              "Cheque",
              "Credit Card",
              "Debit Card",
              "Bank Transfer",
              "Online Payment",
              "Mobile Payment",
              "Electronic Funds Transfer (EFT)",
              "UPI",
              "PhonePe",
              "Amazon",
              "Paytm",
              "FreeCharge",
              "MobikWik",
              "Net Banking",
              "Upi Autopay",
              "ENACH"
            ]
          },
          "accountName": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "transactionDate": {
            "type": "string",
            "format": "date"
          },
          "gatewayId": {
            "type": "string"
          },
          "methodId": {
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "accountId",
          "type",
          "mode",
          "transactionDate"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Transaction, 'transactionId' | 'tenantId' | 'status' | 'appliedAmount' | 'unappliedAmount' | 'createdOn'>"
      },
      "TransactionsWithRelations": {
        "title": "TransactionsWithRelations",
        "type": "object",
        "description": "(tsType: TransactionsWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "transactions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Transaction"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "TransactionsWithRelations"
      },
      "ApplyTransactionWithRelations": {
        "title": "ApplyTransactionWithRelations",
        "type": "object",
        "description": "(tsType: ApplyTransactionWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "transactionId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string"
          },
          "invoiceId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          }
        },
        "required": [
          "transactionId",
          "amount"
        ],
        "additionalProperties": false,
        "x-typescript-type": "ApplyTransactionWithRelations"
      },
      "NewApplyTransaction": {
        "title": "NewApplyTransaction",
        "type": "object",
        "description": "(tsType: ApplyTransaction, schemaOptions: { title: 'NewApplyTransaction' })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "transactionId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string"
          },
          "invoiceId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          }
        },
        "required": [
          "transactionId",
          "amount"
        ],
        "additionalProperties": false,
        "x-typescript-type": "ApplyTransaction"
      },
      "Theme": {
        "title": "Theme",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "category": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Checkout",
              "Self-Serve",
              "Pricing-Table"
            ]
          },
          "theme": {
            "type": "object",
            "nullable": false
          },
          "ratePlan": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": false
            }
          },
          "isOpted": {
            "type": "boolean"
          },
          "apiKey": {
            "type": "string",
            "nullable": false
          }
        },
        "required": [
          "tenantId",
          "theme",
          "isOpted"
        ],
        "additionalProperties": false
      },
      "NewThemeConfig": {
        "title": "NewThemeConfig",
        "type": "object",
        "description": "(tsType: Omit<Theme, 'id'>, schemaOptions: { title: 'NewThemeConfig', exclude: [ 'id' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "category": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Checkout",
              "Self-Serve",
              "Pricing-Table"
            ]
          },
          "theme": {
            "type": "object",
            "nullable": false
          },
          "ratePlan": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": false
            }
          },
          "isOpted": {
            "type": "boolean"
          },
          "apiKey": {
            "type": "string",
            "nullable": false
          }
        },
        "required": [
          "tenantId",
          "theme",
          "isOpted"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Theme, 'id'>"
      },
      "PricingTableRatePlanConfig": {
        "title": "PricingTableRatePlanConfig",
        "type": "object",
        "description": "(tsType: Omit<PricingTableRatePlanConfig, 'ratePlanId'>, schemaOptions: { title: 'PricingTableRatePlanConfig', exclude: [ 'ratePlanId' ] })",
        "properties": {
          "description": {
            "type": "string"
          },
          "features": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "highlightPlan": {
            "type": "boolean"
          },
          "badge": {
            "type": "boolean"
          },
          "badgeText": {
            "type": "string"
          },
          "buttonText": {
            "type": "string"
          },
          "buttonBehavior": {
            "type": "string"
          },
          "redirectURL": {
            "type": "string"
          }
        },
        "required": [
          "features"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<PricingTableRatePlanConfig, 'ratePlanId'>"
      },
      "ThemePartialExcluding_id_": {
        "title": "ThemePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Theme>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "category": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Checkout",
              "Self-Serve",
              "Pricing-Table"
            ]
          },
          "theme": {
            "type": "object",
            "nullable": false
          },
          "ratePlan": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": false
            }
          },
          "isOpted": {
            "type": "boolean"
          },
          "apiKey": {
            "type": "string",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Theme>, 'id'>"
      },
      "TenantWithRelations": {
        "title": "TenantWithRelations",
        "type": "object",
        "description": "(tsType: TenantWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "pincode": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Suspended",
              "Deleted"
            ]
          },
          "timezone": {
            "type": "string"
          },
          "firstLogin": {
            "type": "boolean"
          },
          "keycloakId": {
            "type": "string"
          },
          "batchNo": {
            "type": "number"
          },
          "baseCurrencyCode": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false,
        "x-typescript-type": "TenantWithRelations"
      },
      "TenantPartial": {
        "title": "TenantPartial",
        "type": "object",
        "description": "(tsType: Partial<Tenant>, schemaOptions: { partial: true })",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "pincode": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Suspended",
              "Deleted"
            ]
          },
          "timezone": {
            "type": "string"
          },
          "firstLogin": {
            "type": "boolean"
          },
          "keycloakId": {
            "type": "string"
          },
          "batchNo": {
            "type": "number"
          },
          "baseCurrencyCode": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<Tenant>"
      },
      "Tenant": {
        "title": "Tenant",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "pincode": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Suspended",
              "Deleted"
            ]
          },
          "timezone": {
            "type": "string"
          },
          "firstLogin": {
            "type": "boolean"
          },
          "keycloakId": {
            "type": "string"
          },
          "batchNo": {
            "type": "number"
          },
          "baseCurrencyCode": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      },
      "TemplateView": {
        "title": "TemplateView",
        "type": "object",
        "properties": {
          "templateId": {
            "type": "string",
            "nullable": true
          },
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "subject": {
            "type": "string",
            "nullable": true
          },
          "fileFormat": {
            "type": "string",
            "nullable": true
          },
          "contentFormat": {
            "type": "string",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "nullable": true
          },
          "default": {
            "type": "boolean",
            "nullable": true
          },
          "isSelected": {
            "type": "boolean",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "recipientEntity": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "triggerEvent": {
            "type": "string",
            "nullable": true
          },
          "templateSource": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "NewTemplate": {
        "title": "NewTemplate",
        "type": "object",
        "description": "(tsType: Omit<TemplateView, 'templateId'>, schemaOptions: { title: 'NewTemplate', exclude: [ 'templateId' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "subject": {
            "type": "string",
            "nullable": true
          },
          "fileFormat": {
            "type": "string",
            "nullable": true
          },
          "contentFormat": {
            "type": "string",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "nullable": true
          },
          "default": {
            "type": "boolean",
            "nullable": true
          },
          "isSelected": {
            "type": "boolean",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "recipientEntity": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "triggerEvent": {
            "type": "string",
            "nullable": true
          },
          "templateSource": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<TemplateView, 'templateId'>"
      },
      "TemplateViewPartialExcluding_templateId_": {
        "title": "TemplateViewPartialExcluding_templateId_",
        "type": "object",
        "description": "(tsType: Omit<Partial<TemplateView>, 'templateId'>, schemaOptions: { partial: true, exclude: [ 'templateId' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "subject": {
            "type": "string",
            "nullable": true
          },
          "fileFormat": {
            "type": "string",
            "nullable": true
          },
          "contentFormat": {
            "type": "string",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "nullable": true
          },
          "default": {
            "type": "boolean",
            "nullable": true
          },
          "isSelected": {
            "type": "boolean",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "recipientEntity": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "triggerEvent": {
            "type": "string",
            "nullable": true
          },
          "templateSource": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<TemplateView>, 'templateId'>"
      },
      "TemplateViewWithRelations": {
        "title": "TemplateViewWithRelations",
        "type": "object",
        "description": "(tsType: TemplateViewWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "templateId": {
            "type": "string",
            "nullable": true
          },
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "subject": {
            "type": "string",
            "nullable": true
          },
          "fileFormat": {
            "type": "string",
            "nullable": true
          },
          "contentFormat": {
            "type": "string",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "nullable": true
          },
          "default": {
            "type": "boolean",
            "nullable": true
          },
          "isSelected": {
            "type": "boolean",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "recipientEntity": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "triggerEvent": {
            "type": "string",
            "nullable": true
          },
          "templateSource": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "TemplateViewWithRelations"
      },
      "SubscriptionView": {
        "title": "SubscriptionView",
        "type": "object",
        "properties": {
          "subscriptionId": {
            "type": "string",
            "nullable": true
          },
          "productId": {
            "type": "string",
            "nullable": true
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true
          },
          "ratePlanId": {
            "type": "string",
            "nullable": true
          },
          "ratePlanName": {
            "type": "string",
            "nullable": true
          },
          "accountId": {
            "type": "string",
            "nullable": true
          },
          "accountName": {
            "type": "string",
            "nullable": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": true
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "currency": {
            "type": "string",
            "nullable": true
          },
          "billingCycle": {
            "type": "number",
            "nullable": true
          },
          "paymentMethodId": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "priceOverride": {
            "type": "number",
            "nullable": true
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "trialPeriodId": {
            "type": "string",
            "nullable": true
          },
          "trialPeriod": {
            "type": "object",
            "nullable": true
          },
          "billingPeriod": {
            "type": "object",
            "nullable": true
          },
          "autoCollect": {
            "type": "boolean",
            "nullable": true
          },
          "poNumber": {
            "type": "string",
            "nullable": true
          },
          "autoCloseInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "autoCloseRenewalInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "freePeriod": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "invoiceGenerationPreference": {
            "type": "string",
            "nullable": true
          },
          "pauseDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "resumeDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "orderItemId": {
            "type": "string",
            "nullable": true
          },
          "termSubscriptionId": {
            "type": "string",
            "nullable": true
          },
          "termStartDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "termEndDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "version": {
            "type": "number",
            "nullable": true
          },
          "usedDays": {
            "type": "number",
            "nullable": true
          },
          "totalDays": {
            "type": "number",
            "nullable": true
          },
          "cancelDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "cancelOptions": {
            "type": "object"
          },
          "cancellationReason": {
            "type": "string"
          },
          "minimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "noticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "earlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "earlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "planMinimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "planNoticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "planEarlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "planEarlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "fixedCycles": {
            "type": "number",
            "nullable": true,
            "minimum": 1
          },
          "walletExhausted": {
            "type": "boolean",
            "nullable": true
          }
        },
        "required": [
          "isTrial"
        ],
        "additionalProperties": false
      },
      "Subscriptions": {
        "title": "Subscriptions",
        "type": "object",
        "properties": {
          "subscriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "SubscriptionAddonView": {
        "title": "SubscriptionAddonView",
        "type": "object",
        "properties": {
          "subscriptionAddonId": {
            "type": "string",
            "nullable": true
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "termSubscriptionId": {
            "type": "string",
            "nullable": true
          },
          "addonPriceId": {
            "type": "string",
            "nullable": true
          },
          "addonName": {
            "type": "string",
            "nullable": true
          },
          "attachedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "orderItemId": {
            "type": "string",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true,
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "pricingModel": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Flat Fee Pricing",
              "Per Unit Pricing",
              "Volume Pricing"
            ]
          },
          "applicability": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Mandatory",
              "Recommended",
              "Optional"
            ]
          },
          "priceIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "usedDays": {
            "type": "number",
            "nullable": true
          },
          "totalDays": {
            "type": "number",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "billingPeriod": {
            "type": "object",
            "nullable": true
          },
          "periodRatio": {
            "type": "number",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderItem": {
        "title": "OrderItem",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "itemId": {
            "type": "string",
            "format": "uuid"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "nextBillingDate": {
            "type": "string",
            "format": "date"
          },
          "name": {
            "type": "string"
          },
          "orderId": {
            "type": "string",
            "format": "uuid"
          },
          "quantity": {
            "type": "number"
          },
          "periodRatio": {
            "type": "number"
          },
          "amount": {
            "type": "number"
          },
          "unitPrice": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "Pending",
              "Completed",
              "Canceled",
              "Returned",
              "Refunded",
              "Reserved"
            ]
          },
          "itemType": {
            "type": "string",
            "enum": [
              "Tax",
              "Discount",
              "Coupon",
              "Subscription",
              "Addon",
              "Charge",
              "Rate Plan",
              "Price Component"
            ]
          },
          "options": {
            "type": "object"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "itemId",
          "quantity",
          "itemType"
        ],
        "additionalProperties": false
      },
      "OrderDetails": {
        "title": "OrderDetails",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "totalAmount": {
            "type": "number"
          },
          "dueAmount": {
            "type": "number"
          },
          "subTotal": {
            "type": "number"
          },
          "tax": {
            "type": "number"
          },
          "discount": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "Created",
              "Awaiting Mandate",
              "Payment Pending",
              "Processed Payment Pending",
              "Payment Received",
              "Invoiced",
              "Completed",
              "Cancelled",
              "Failed",
              "Refunded"
            ]
          },
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "eventType": {
            "type": "string",
            "enum": [
              "NEW SUBSCRIPTION",
              "TRIAL ACTIVATION",
              "ADD ADDON",
              "PAUSE SUBSCRIPTION",
              "RESUME SUBSCRIPTION",
              "CANCEL SUBSCRIPTION",
              "EXPIRE SUBSCRIPTION",
              "RENEW SUBSCRIPTION",
              "REACTIVATE SUBSCRIPTION",
              "CHANGE PLAN",
              "FREQUENCY CHANGE",
              "WALLET TOP-UP"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "salesRepId": {
            "type": "string",
            "format": "uuid"
          },
          "credits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "debits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "options": {
            "type": "object"
          },
          "workflowProcessInstanceId": {
            "type": "string"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderItem"
            }
          }
        },
        "required": [
          "id",
          "tenantId",
          "date",
          "accountId",
          "status",
          "srcSysCode",
          "eventType",
          "currency"
        ],
        "additionalProperties": false
      },
      "PaymentDetails": {
        "title": "PaymentDetails",
        "type": "object",
        "properties": {
          "paymentMethodId": {
            "type": "string",
            "format": "uuid"
          },
          "sendPaymentLink": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "CartItem": {
        "title": "CartItem",
        "type": "object",
        "properties": {
          "itemType": {
            "type": "string",
            "enum": [
              "Tax",
              "Discount",
              "Coupon",
              "Subscription",
              "Addon",
              "Charge",
              "Rate Plan",
              "Price Component"
            ]
          },
          "itemId": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "fromDate": {
            "type": "string"
          },
          "toDate": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "ratio": {
            "type": "number"
          },
          "unitPrice": {
            "type": "number"
          },
          "amount": {
            "type": "number"
          },
          "options": {
            "type": "object"
          },
          "isTrial": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "Pending",
              "Reserved",
              "Rejected"
            ]
          },
          "nextBillingDate": {
            "type": "string",
            "format": "date"
          }
        },
        "required": [
          "itemType",
          "itemId"
        ],
        "additionalProperties": false
      },
      "PersonalInfo": {
        "title": "PersonalInfo",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "accountType": {
            "type": "string",
            "enum": [
              "Organisation",
              "Individual"
            ]
          }
        },
        "additionalProperties": false
      },
      "NewSubscriptionOrder": {
        "title": "NewSubscriptionOrder",
        "type": "object",
        "description": "(tsType: Omit<OrderData, 'eventType' | 'subscriptionId' | 'workflowProcessInstanceId'>, schemaOptions: { title: 'NewSubscriptionOrder', exclude: [ 'eventType', 'subscriptionId', 'workflowProcessInstanceId' ] })",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "options": {
            "type": "object"
          }
        },
        "required": [
          "srcSysCode",
          "currency",
          "cart"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OrderData, 'eventType' | 'subscriptionId' | 'workflowProcessInstanceId'>"
      },
      "OrderData": {
        "title": "OrderData",
        "type": "object",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "eventType": {
            "type": "string",
            "enum": [
              "NEW SUBSCRIPTION",
              "TRIAL ACTIVATION",
              "ADD ADDON",
              "PAUSE SUBSCRIPTION",
              "RESUME SUBSCRIPTION",
              "CANCEL SUBSCRIPTION",
              "EXPIRE SUBSCRIPTION",
              "RENEW SUBSCRIPTION",
              "REACTIVATE SUBSCRIPTION",
              "CHANGE PLAN",
              "FREQUENCY CHANGE",
              "WALLET TOP-UP"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "subscriptionId": {
            "type": "string"
          },
          "options": {
            "type": "object"
          },
          "workflowProcessInstanceId": {
            "type": "string",
            "description": "Camunda workflow process instance ID for tracking"
          }
        },
        "required": [
          "srcSysCode",
          "eventType",
          "currency",
          "cart"
        ],
        "additionalProperties": false
      },
      "ChangePlanOrder": {
        "title": "ChangePlanOrder",
        "type": "object",
        "description": "(tsType: Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>, schemaOptions: { title: 'ChangePlanOrder', exclude: [ 'eventType', 'workflowProcessInstanceId' ] })",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "subscriptionId": {
            "type": "string"
          },
          "options": {
            "type": "object"
          }
        },
        "required": [
          "srcSysCode",
          "currency",
          "cart"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>"
      },
      "ChangeFrequencyOrder": {
        "title": "ChangeFrequencyOrder",
        "type": "object",
        "description": "(tsType: Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>, schemaOptions: { title: 'ChangeFrequencyOrder', exclude: [ 'eventType', 'workflowProcessInstanceId' ] })",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "subscriptionId": {
            "type": "string"
          },
          "options": {
            "type": "object"
          }
        },
        "required": [
          "srcSysCode",
          "currency",
          "cart"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>"
      },
      "AddAddonOrder": {
        "title": "AddAddonOrder",
        "type": "object",
        "description": "(tsType: Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>, schemaOptions: { title: 'AddAddonOrder', exclude: [ 'eventType', 'workflowProcessInstanceId' ] })",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "subscriptionId": {
            "type": "string"
          },
          "options": {
            "type": "object"
          }
        },
        "required": [
          "srcSysCode",
          "currency",
          "cart"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OrderData, 'eventType' | 'workflowProcessInstanceId'>"
      },
      "Addon": {
        "title": "Addon",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "addonKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "name",
          "status",
          "addonKey",
          "isVisibleInPortal",
          "productId",
          "tenantId"
        ],
        "additionalProperties": false
      },
      "CalculateCostResponse": {
        "title": "CalculateCostResponse",
        "type": "object",
        "properties": {
          "price": {
            "type": "number"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Addon"
            }
          }
        },
        "additionalProperties": false
      },
      "calculateCost": {
        "title": "calculateCost",
        "type": "object",
        "description": "(tsType: Omit<CalculateCost, >, schemaOptions: { title: 'calculateCost', exclude: [] })",
        "properties": {
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "format": "uuid"
          },
          "tillTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<CalculateCost, >"
      },
      "CalculateCost": {
        "title": "CalculateCost",
        "type": "object",
        "properties": {
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "format": "uuid"
          },
          "tillTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "Subscription": {
        "title": "Subscription",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": false
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "currency": {
            "type": "string",
            "nullable": false,
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "paymentMethodId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "autoCollect": {
            "type": "boolean",
            "nullable": false
          },
          "autoCloseInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "autoCloseRenewalInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Future",
              "Trial",
              "Trial Pending Activation",
              "Trial Expired",
              "Active",
              "Paused",
              "Cancelled",
              "Non Renewing",
              "Expired",
              "In Dunning"
            ]
          },
          "invoiceGenerationPreference": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Immediately",
              "Unbilled"
            ]
          },
          "pauseDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "resumeDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "cancelDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "cancelOptions": {
            "type": "object",
            "nullable": true
          },
          "cancellationReason": {
            "type": "string",
            "nullable": true
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "minimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "noticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "earlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "earlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "fixedCycles": {
            "type": "number",
            "nullable": true,
            "minimum": 1
          },
          "walletExhausted": {
            "type": "boolean",
            "nullable": true
          }
        },
        "required": [
          "accountId",
          "autoRenew",
          "tenantId",
          "productId",
          "currency",
          "autoCollect",
          "autoCloseInvoice",
          "autoCloseRenewalInvoice",
          "status",
          "invoiceGenerationPreference"
        ],
        "additionalProperties": false
      },
      "PauseSubscription": {
        "title": "PauseSubscription",
        "type": "object",
        "description": "(tsType: PauseSubscription, schemaOptions: { title: 'PauseSubscription' })",
        "properties": {
          "pauseOption": {
            "type": "string",
            "enum": [
              "Immediately",
              "End of Term",
              "Specific Date"
            ]
          },
          "pauseDate": {
            "type": "string",
            "format": "date"
          },
          "resumeDate": {
            "type": "string",
            "format": "date"
          },
          "srcSysCode": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "PauseSubscription"
      },
      "ResumeSubscription": {
        "title": "ResumeSubscription",
        "type": "object",
        "description": "(tsType: ResumeSubscription, schemaOptions: { title: 'ResumeSubscription' })",
        "properties": {
          "resumeOption": {
            "type": "string",
            "enum": [
              "Immediately",
              "Specific Date"
            ]
          },
          "resumeDate": {
            "type": "string",
            "format": "date"
          },
          "srcSysCode": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "ResumeSubscription"
      },
      "CancelSubscription": {
        "title": "CancelSubscription",
        "type": "object",
        "description": "(tsType: CancelSubscription, schemaOptions: { title: 'CancelSubscription' })",
        "properties": {
          "cancelOption": {
            "type": "string",
            "enum": [
              "Immediately",
              "End of Term",
              "Specific Date"
            ]
          },
          "cancelDate": {
            "type": "string",
            "format": "date"
          },
          "unusedPeriodCreditPolicy": {
            "type": "string",
            "enum": [
              "Don't issue credits",
              "Issue prorated credits",
              "Issue full credits"
            ]
          },
          "refundableCreditAction": {
            "type": "string",
            "enum": [
              "Retain credits",
              "Initiate refund"
            ]
          },
          "unpaidInvoiceHandlingPolicy": {
            "type": "string",
            "enum": [
              "Retain as unpaid",
              "Attempt Collection",
              "Write Off"
            ]
          },
          "unbilledChargeHandlingPolicy": {
            "type": "string",
            "enum": [
              "Invoice charges",
              "Delete Charges"
            ]
          },
          "cancellationReason": {
            "type": "string"
          },
          "overrideContractTerms": {
            "type": "boolean",
            "description": "Admin override: skip the notice-period check and waive the early-termination fee. Requires overrideReason and an admin channel (BillHive Web App or API)."
          },
          "overrideReason": {
            "type": "string",
            "description": "Why the contract terms are overridden. Required when overrideContractTerms is true."
          },
          "srcSysCode": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "CancelSubscription"
      },
      "AuditLog": {
        "title": "AuditLog",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "action": {
            "type": "string"
          },
          "actedAt": {
            "type": "string",
            "format": "date-time"
          },
          "actedOn": {
            "type": "string"
          },
          "actionKey": {
            "type": "string"
          },
          "entityId": {
            "type": "string"
          },
          "actor": {
            "type": "string"
          },
          "before": {
            "type": "object"
          },
          "after": {
            "type": "object"
          }
        },
        "required": [
          "action",
          "actedAt",
          "actionKey",
          "actor"
        ],
        "additionalProperties": false
      },
      "SubscriptionTerm": {
        "title": "SubscriptionTerm",
        "type": "object",
        "properties": {
          "startDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "version": {
            "type": "number",
            "nullable": false
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "id": {
            "type": "string",
            "nullable": false
          },
          "usedDays": {
            "type": "number",
            "nullable": false
          },
          "totalDays": {
            "type": "number",
            "nullable": false
          },
          "isActive": {
            "type": "boolean",
            "nullable": false
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "billingCycle": {
            "type": "number",
            "nullable": false
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "trialPeriodId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "poNumber": {
            "type": "string",
            "nullable": true
          },
          "freePeriod": {
            "type": "string",
            "nullable": true
          },
          "orderItemId": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "priceOverride": {
            "type": "number",
            "nullable": true
          },
          "mrr": {
            "type": "number",
            "nullable": true
          }
        },
        "required": [
          "version",
          "ratePlanPriceId",
          "usedDays",
          "totalDays",
          "isActive",
          "isTrial",
          "billingCycle"
        ],
        "additionalProperties": false
      },
      "SubscriptionSettings": {
        "title": "SubscriptionSettings",
        "type": "object",
        "properties": {
          "settingId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "settingKey": {
            "type": "string",
            "nullable": false
          },
          "settingValue": {
            "type": "object"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "category": {
            "type": "string",
            "enum": [
              "Subscription",
              "Billing",
              "Proration",
              "Activation",
              "Renewal",
              "Trial",
              "Usage",
              "Pause Subscription",
              "Resume Subscription",
              "Cancel Subscription",
              "Dunning"
            ]
          }
        },
        "required": [
          "settingId",
          "settingKey",
          "settingValue",
          "category"
        ],
        "additionalProperties": false
      },
      "NewSubscriptionSettings": {
        "title": "NewSubscriptionSettings",
        "type": "object",
        "description": "(tsType: Omit<SubscriptionSettings, 'settingId' | 'tenantId'>, schemaOptions: { title: 'NewSubscriptionSettings', exclude: [ 'settingId', 'tenantId' ] })",
        "properties": {
          "settingKey": {
            "type": "string",
            "nullable": false
          },
          "settingValue": {
            "type": "object"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "category": {
            "type": "string",
            "enum": [
              "Subscription",
              "Billing",
              "Proration",
              "Activation",
              "Renewal",
              "Trial",
              "Usage",
              "Pause Subscription",
              "Resume Subscription",
              "Cancel Subscription",
              "Dunning"
            ]
          }
        },
        "required": [
          "settingKey",
          "settingValue",
          "category"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<SubscriptionSettings, 'settingId' | 'tenantId'>"
      },
      "SubscriptionSettingsWithRelations": {
        "title": "SubscriptionSettingsWithRelations",
        "type": "object",
        "description": "(tsType: SubscriptionSettingsWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "settingId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "settingKey": {
            "type": "string",
            "nullable": false
          },
          "settingValue": {
            "type": "object"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "category": {
            "type": "string",
            "enum": [
              "Subscription",
              "Billing",
              "Proration",
              "Activation",
              "Renewal",
              "Trial",
              "Usage",
              "Pause Subscription",
              "Resume Subscription",
              "Cancel Subscription",
              "Dunning"
            ]
          }
        },
        "required": [
          "settingId",
          "settingKey",
          "settingValue",
          "category"
        ],
        "additionalProperties": false,
        "x-typescript-type": "SubscriptionSettingsWithRelations"
      },
      "SubscriptionSettingsPartial": {
        "title": "SubscriptionSettingsPartial",
        "type": "object",
        "description": "(tsType: Partial<SubscriptionSettings>, schemaOptions: { partial: true })",
        "properties": {
          "settingId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "settingKey": {
            "type": "string",
            "nullable": false
          },
          "settingValue": {
            "type": "object"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "category": {
            "type": "string",
            "enum": [
              "Subscription",
              "Billing",
              "Proration",
              "Activation",
              "Renewal",
              "Trial",
              "Usage",
              "Pause Subscription",
              "Resume Subscription",
              "Cancel Subscription",
              "Dunning"
            ]
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<SubscriptionSettings>"
      },
      "SubscriptionEntitlement": {
        "title": "SubscriptionEntitlement",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "isOverride": {
            "type": "boolean",
            "nullable": false
          },
          "overrideReason": {
            "type": "string",
            "nullable": true
          },
          "overrideExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "subscriptionId",
          "featureId",
          "isOverride"
        ],
        "additionalProperties": false
      },
      "NewSubscriptionEntitlement": {
        "title": "NewSubscriptionEntitlement",
        "type": "object",
        "description": "(tsType: Omit<SubscriptionEntitlement, 'id' | 'subscriptionId'>, schemaOptions: { title: 'NewSubscriptionEntitlement', exclude: [ 'id', 'subscriptionId' ] })",
        "properties": {
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "isOverride": {
            "type": "boolean",
            "nullable": false
          },
          "overrideReason": {
            "type": "string",
            "nullable": true
          },
          "overrideExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "featureId",
          "isOverride"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<SubscriptionEntitlement, 'id' | 'subscriptionId'>"
      },
      "SubscriptionEntitlementPartialExcluding_id-subscriptionId_": {
        "title": "SubscriptionEntitlementPartialExcluding_id-subscriptionId_",
        "type": "object",
        "description": "(tsType: Omit<Partial<SubscriptionEntitlement>, 'id' | 'subscriptionId'>, schemaOptions: { partial: true, exclude: [ 'id', 'subscriptionId' ] })",
        "properties": {
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "isOverride": {
            "type": "boolean",
            "nullable": false
          },
          "overrideReason": {
            "type": "string",
            "nullable": true
          },
          "overrideExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<SubscriptionEntitlement>, 'id' | 'subscriptionId'>"
      },
      "RatePlan": {
        "title": "RatePlan",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "ratePlanKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isVisibleInCheckout": {
            "type": "boolean",
            "nullable": false
          },
          "redirectUrl": {
            "type": "string",
            "nullable": true
          },
          "planLevel": {
            "type": "number",
            "nullable": true
          },
          "mostPopular": {
            "type": "boolean",
            "nullable": false
          },
          "minimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "noticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "earlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "earlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          }
        },
        "required": [
          "name",
          "ratePlanKey",
          "isVisibleInPortal",
          "productId",
          "tenantId",
          "isVisibleInCheckout"
        ],
        "additionalProperties": false
      },
      "NewRatePlan": {
        "title": "NewRatePlan",
        "type": "object",
        "description": "(tsType: Omit<RatePlan, 'ratePlanId' | 'tenantId'>, schemaOptions: { title: 'NewRatePlan', exclude: [ 'ratePlanId', 'tenantId' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "ratePlanKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isVisibleInCheckout": {
            "type": "boolean",
            "nullable": false
          },
          "redirectUrl": {
            "type": "string",
            "nullable": true
          },
          "planLevel": {
            "type": "number",
            "nullable": true
          },
          "mostPopular": {
            "type": "boolean",
            "nullable": false
          },
          "minimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "noticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "earlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "earlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          }
        },
        "required": [
          "name",
          "ratePlanKey",
          "isVisibleInPortal",
          "productId",
          "isVisibleInCheckout"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<RatePlan, 'ratePlanId' | 'tenantId'>"
      },
      "RatePlansWithRelations": {
        "title": "RatePlansWithRelations",
        "type": "object",
        "description": "(tsType: RatePlansWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "ratePlans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlan"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "RatePlansWithRelations"
      },
      "RatePlanPartialExcluding_id_": {
        "title": "RatePlanPartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<RatePlan>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "ratePlanKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isVisibleInCheckout": {
            "type": "boolean",
            "nullable": false
          },
          "redirectUrl": {
            "type": "string",
            "nullable": true
          },
          "planLevel": {
            "type": "number",
            "nullable": true
          },
          "mostPopular": {
            "type": "boolean",
            "nullable": false
          },
          "minimumCommitmentMonths": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "noticePeriodDays": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          },
          "earlyTerminationFeeType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "FIXED",
              "PERCENTAGE",
              "REMAINING_VALUE",
              null
            ]
          },
          "earlyTerminationFeeValue": {
            "type": "number",
            "nullable": true,
            "minimum": 0
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<RatePlan>, 'id'>"
      },
      "RatePlanPrice": {
        "title": "RatePlanPrice",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "In Review",
              "Approved",
              "Active",
              "Inactive"
            ]
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "requireBillingAtSignup": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "number",
            "nullable": false
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": false
          },
          "currencyCode": {
            "type": "string",
            "nullable": false,
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "price": {
            "type": "number",
            "nullable": false
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "trialPeriodId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isAutoCalculated": {
            "type": "boolean",
            "nullable": false
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed Pricing",
              "Per Unit Pricing",
              "Volume Pricing",
              "Tiered Pricing",
              "Hybrid Pricing",
              "Percentage Pricing"
            ]
          },
          "ratePlanPriceKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "freeQuantity": {
            "type": "number",
            "nullable": true
          },
          "billingCycle": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Forever"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "highlightPlan": {
            "type": "boolean",
            "nullable": false
          },
          "showStrikethrough": {
            "type": "boolean",
            "nullable": false
          },
          "strikethroughPrice": {
            "type": "number",
            "nullable": false
          },
          "showPrice": {
            "type": "boolean",
            "nullable": false
          },
          "ctaButtonBehavior": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Open Checkout",
              "Redirect To Url"
            ]
          },
          "ctaButtonLabel": {
            "type": "string",
            "nullable": true
          },
          "customBadge": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          },
          "creditPacks": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": true
            }
          },
          "grantAmount": {
            "type": "number",
            "nullable": true
          },
          "grantFrequency": {
            "type": "string",
            "enum": [
              "ONCE",
              "EVERY_PERIOD",
              null
            ],
            "nullable": true
          },
          "rollover": {
            "type": "boolean",
            "nullable": true
          },
          "creditExpiryDays": {
            "type": "number",
            "nullable": true
          },
          "walletZeroBalanceAction": {
            "type": "string",
            "enum": [
              "BILL_OVERAGE",
              "AUTO_TOP_UP",
              "BLOCK",
              null
            ],
            "nullable": true
          },
          "autoTopUpPack": {
            "type": "number",
            "nullable": true
          },
          "autoTopUpThreshold": {
            "type": "number",
            "nullable": true
          },
          "commitmentAmount": {
            "type": "number",
            "nullable": true
          },
          "commitmentPeriod": {
            "type": "string",
            "enum": [
              "BILLING_PERIOD",
              "CONTRACT",
              null
            ],
            "nullable": true
          }
        },
        "required": [
          "name",
          "productId",
          "tenantId",
          "isTrial",
          "status",
          "requireBillingAtSignup",
          "termLength",
          "autoRenew",
          "currencyCode",
          "price",
          "ratePlanId",
          "billingPeriodId",
          "isAutoCalculated",
          "taxIncluded",
          "pricingModel",
          "ratePlanPriceKey",
          "billingCycle",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false
      },
      "NewRatePlanPrice": {
        "title": "NewRatePlanPrice",
        "type": "object",
        "description": "(tsType: Omit<RatePlanPrice, 'tenantId' | 'ratePlanId' | 'status' | 'autoRenew' | 'isAutoCalculated' | 'createdTs' | 'updatedTs' | 'creditPacks' | 'grantAmount' | 'grantFrequency' | 'rollover' | 'creditExpiryDays' | 'walletZeroBalanceAction' | 'autoTopUpPack' | 'autoTopUpThreshold'>, schemaOptions: { title: 'NewRatePlanPrice', exclude: [ 'tenantId', 'ratePlanId', 'status', 'autoRenew', 'isAutoCalculated', 'createdTs', 'updatedTs', 'creditPacks', 'grantAmount', 'grantFrequency', 'rollover', 'creditExpiryDays', 'walletZeroBalanceAction', 'autoTopUpPack', 'autoTopUpThreshold' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "requireBillingAtSignup": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "number",
            "nullable": false
          },
          "currencyCode": {
            "type": "string",
            "nullable": false,
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "price": {
            "type": "number",
            "nullable": false
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "trialPeriodId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed Pricing",
              "Per Unit Pricing",
              "Volume Pricing",
              "Tiered Pricing",
              "Hybrid Pricing",
              "Percentage Pricing"
            ]
          },
          "ratePlanPriceKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "freeQuantity": {
            "type": "number",
            "nullable": true
          },
          "billingCycle": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Forever"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "highlightPlan": {
            "type": "boolean",
            "nullable": false
          },
          "showStrikethrough": {
            "type": "boolean",
            "nullable": false
          },
          "strikethroughPrice": {
            "type": "number",
            "nullable": false
          },
          "showPrice": {
            "type": "boolean",
            "nullable": false
          },
          "ctaButtonBehavior": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Open Checkout",
              "Redirect To Url"
            ]
          },
          "ctaButtonLabel": {
            "type": "string",
            "nullable": true
          },
          "customBadge": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          },
          "commitmentAmount": {
            "type": "number",
            "nullable": true
          },
          "commitmentPeriod": {
            "type": "string",
            "enum": [
              "BILLING_PERIOD",
              "CONTRACT",
              null
            ],
            "nullable": true
          }
        },
        "required": [
          "name",
          "productId",
          "isTrial",
          "requireBillingAtSignup",
          "termLength",
          "currencyCode",
          "price",
          "billingPeriodId",
          "taxIncluded",
          "pricingModel",
          "ratePlanPriceKey",
          "billingCycle",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<RatePlanPrice, 'tenantId' | 'ratePlanId' | 'status' | 'autoRenew' | 'isAutoCalculated' | 'createdTs' | 'updatedTs' | 'creditPacks' | 'grantAmount' | 'grantFrequency' | 'rollover' | 'creditExpiryDays' | 'walletZeroBalanceAction' | 'autoTopUpPack' | 'autoTopUpThreshold'>"
      },
      "RatePlanPriceView": {
        "title": "RatePlanPriceView",
        "type": "object",
        "properties": {
          "ratePlanId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "ratePlanKey": {
            "type": "string",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          },
          "productId": {
            "type": "string",
            "nullable": true
          },
          "productName": {
            "type": "string"
          },
          "isVisibleInCheckout": {
            "type": "boolean",
            "nullable": true
          },
          "redirectUrl": {
            "type": "string",
            "nullable": true
          },
          "planLevel": {
            "type": "number",
            "nullable": true
          },
          "mostPopular": {
            "type": "boolean",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true
          },
          "isTrial": {
            "type": "boolean",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "customerDescription": {
            "type": "string",
            "nullable": true
          },
          "requireBillingAtSignup": {
            "type": "boolean",
            "nullable": true
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": true
          },
          "termLength": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "trialPeriod": {
            "$ref": "#/components/schemas/Period"
          },
          "billingPeriod": {
            "$ref": "#/components/schemas/Period"
          },
          "isAutoCalculated": {
            "type": "boolean",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "pricingModel": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceKey": {
            "type": "string",
            "nullable": true
          },
          "freeQuantity": {
            "type": "number",
            "nullable": true
          },
          "billingCycle": {
            "type": "string",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": true
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "highlightPlan": {
            "type": "boolean",
            "nullable": false
          },
          "showStrikethrough": {
            "type": "boolean",
            "nullable": false
          },
          "strikethroughPrice": {
            "type": "number",
            "nullable": false
          },
          "showPrice": {
            "type": "boolean",
            "nullable": false
          },
          "ctaButtonBehavior": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Open Checkout",
              "Redirect To Url"
            ]
          },
          "ctaButtonLabel": {
            "type": "string",
            "nullable": true
          },
          "customBadge": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean",
            "nullable": true
          },
          "creditPacks": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": true
            }
          },
          "grantAmount": {
            "type": "number",
            "nullable": true
          },
          "grantFrequency": {
            "type": "string",
            "enum": [
              "ONCE",
              "EVERY_PERIOD",
              null
            ],
            "nullable": true
          },
          "rollover": {
            "type": "boolean",
            "nullable": true
          },
          "creditExpiryDays": {
            "type": "number",
            "nullable": true
          },
          "walletZeroBalanceAction": {
            "type": "string",
            "enum": [
              "BILL_OVERAGE",
              "AUTO_TOP_UP",
              "BLOCK",
              null
            ],
            "nullable": true
          },
          "autoTopUpPack": {
            "type": "number",
            "nullable": true
          },
          "autoTopUpThreshold": {
            "type": "number",
            "nullable": true
          },
          "commitmentAmount": {
            "type": "number",
            "nullable": true
          },
          "commitmentPeriod": {
            "type": "string",
            "enum": [
              "BILLING_PERIOD",
              "CONTRACT",
              null
            ],
            "nullable": true
          }
        },
        "required": [
          "productName"
        ],
        "additionalProperties": false
      },
      "RatePlanPrices": {
        "title": "RatePlanPrices",
        "type": "object",
        "properties": {
          "ratePlanPrices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanPriceView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "RatePlanPricePartialExcluding_id-creditPacks-grantAmount-grantFrequency-rollover-creditExpiryDays-walletZeroBalanceAction-autoTopUpPack-autoTopUpThreshold_": {
        "title": "RatePlanPricePartialExcluding_id-creditPacks-grantAmount-grantFrequency-rollover-creditExpiryDays-walletZeroBalanceAction-autoTopUpPack-autoTopUpThreshold_",
        "type": "object",
        "description": "(tsType: Omit<Partial<RatePlanPrice>, 'id' | 'creditPacks' | 'grantAmount' | 'grantFrequency' | 'rollover' | 'creditExpiryDays' | 'walletZeroBalanceAction' | 'autoTopUpPack' | 'autoTopUpThreshold'>, schemaOptions: { partial: true, exclude: [ 'id', 'creditPacks', 'grantAmount', 'grantFrequency', 'rollover', 'creditExpiryDays', 'walletZeroBalanceAction', 'autoTopUpPack', 'autoTopUpThreshold' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isTrial": {
            "type": "boolean",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "In Review",
              "Approved",
              "Active",
              "Inactive"
            ]
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "requireBillingAtSignup": {
            "type": "boolean",
            "nullable": false
          },
          "termLength": {
            "type": "number",
            "nullable": false
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": false
          },
          "currencyCode": {
            "type": "string",
            "nullable": false,
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "price": {
            "type": "number",
            "nullable": false
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "trialPeriodId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isAutoCalculated": {
            "type": "boolean",
            "nullable": false
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed Pricing",
              "Per Unit Pricing",
              "Volume Pricing",
              "Tiered Pricing",
              "Hybrid Pricing",
              "Percentage Pricing"
            ]
          },
          "ratePlanPriceKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "freeQuantity": {
            "type": "number",
            "nullable": true
          },
          "billingCycle": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Forever"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "highlightPlan": {
            "type": "boolean",
            "nullable": false
          },
          "showStrikethrough": {
            "type": "boolean",
            "nullable": false
          },
          "strikethroughPrice": {
            "type": "number",
            "nullable": false
          },
          "showPrice": {
            "type": "boolean",
            "nullable": false
          },
          "ctaButtonBehavior": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Open Checkout",
              "Redirect To Url"
            ]
          },
          "ctaButtonLabel": {
            "type": "string",
            "nullable": true
          },
          "customBadge": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          },
          "commitmentAmount": {
            "type": "number",
            "nullable": true
          },
          "commitmentPeriod": {
            "type": "string",
            "enum": [
              "BILLING_PERIOD",
              "CONTRACT",
              null
            ],
            "nullable": true
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<RatePlanPrice>, 'id' | 'creditPacks' | 'grantAmount' | 'grantFrequency' | 'rollover' | 'creditExpiryDays' | 'walletZeroBalanceAction' | 'autoTopUpPack' | 'autoTopUpThreshold'>"
      },
      "RatePlanAddon": {
        "title": "RatePlanAddon",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "isPriceIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Mandatory",
              "Recommended",
              "Optional"
            ]
          }
        },
        "required": [
          "ratePlanId",
          "addonId",
          "isPriceIncluded",
          "applicability"
        ],
        "additionalProperties": false
      },
      "NewRatePlanAddon": {
        "title": "NewRatePlanAddon",
        "type": "object",
        "description": "(tsType: Omit<RatePlanAddon, 'ratePlanId' | 'status' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewRatePlanAddon', exclude: [ 'ratePlanId', 'status', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "isPriceIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Mandatory",
              "Recommended",
              "Optional"
            ]
          }
        },
        "required": [
          "addonId",
          "isPriceIncluded",
          "applicability"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<RatePlanAddon, 'ratePlanId' | 'status' | 'createdTs' | 'updatedTs'>"
      },
      "RatePlanCharge": {
        "title": "RatePlanCharge",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "chargeId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "triggerCondition": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Subscription Creation",
              "Subscription Trial Start",
              "Plan Activation",
              "Subscription Activation",
              "Immediately",
              "Contract Termination",
              "On Demand"
            ]
          }
        },
        "required": [
          "ratePlanId",
          "chargeId",
          "triggerCondition"
        ],
        "additionalProperties": false
      },
      "NewRatePlanCharge": {
        "title": "NewRatePlanCharge",
        "type": "object",
        "description": "(tsType: Omit<RatePlanCharge, 'ratePlanId' | 'status' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewRatePlanCharge', exclude: [ 'ratePlanId', 'status', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "chargeId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "triggerCondition": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Subscription Creation",
              "Subscription Trial Start",
              "Plan Activation",
              "Subscription Activation",
              "Immediately",
              "Contract Termination",
              "On Demand"
            ]
          }
        },
        "required": [
          "chargeId",
          "triggerCondition"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<RatePlanCharge, 'ratePlanId' | 'status' | 'createdTs' | 'updatedTs'>"
      },
      "RatePlanAddonView": {
        "title": "RatePlanAddonView",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "ratePlanId": {
            "type": "string",
            "nullable": true
          },
          "isPriceIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "applicability": {
            "type": "string",
            "nullable": true
          },
          "addonId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "addonKey": {
            "type": "string",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RatePlanAddons": {
        "title": "RatePlanAddons",
        "type": "object",
        "properties": {
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanAddonView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "RatePlanPriceAddonPriceView": {
        "title": "RatePlanPriceAddonPriceView",
        "type": "object",
        "properties": {
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true
          },
          "addonId": {
            "type": "string",
            "nullable": true
          },
          "addonPriceId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "customerDescription": {
            "type": "string",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": true
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "addonPriceKey": {
            "type": "string",
            "nullable": true
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "pricingModel": {
            "type": "string",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "billingPeriod": {
            "type": "object",
            "nullable": true
          },
          "isPriceIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "applicability": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Mandatory",
              "Recommended",
              "Optional"
            ]
          }
        },
        "additionalProperties": false
      },
      "RatePlanChargeView": {
        "title": "RatePlanChargeView",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "ratePlanId": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "triggerCondition": {
            "type": "string",
            "nullable": true,
            "enum": [
              "Subscription Creation",
              "Subscription Trial Start",
              "Plan Activation",
              "Subscription Activation",
              "Immediately",
              "Contract Termination",
              "On Demand"
            ]
          },
          "chargeId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "chargeKey": {
            "type": "string",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RatePlanCharges": {
        "title": "RatePlanCharges",
        "type": "object",
        "properties": {
          "charges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanChargeView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "RatePlanPricesWithRelations": {
        "title": "RatePlanPricesWithRelations",
        "type": "object",
        "description": "(tsType: RatePlanPricesWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "ratePlanPrices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanPriceView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "RatePlanPricesWithRelations"
      },
      "RatePlanFeature": {
        "title": "RatePlanFeature",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "ratePlanId",
          "featureId"
        ],
        "additionalProperties": false
      },
      "NewRatePlanFeature": {
        "title": "NewRatePlanFeature",
        "type": "object",
        "description": "(tsType: Omit<RatePlanFeature, 'id'>, schemaOptions: { title: 'NewRatePlanFeature', exclude: [ 'id' ] })",
        "properties": {
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "ratePlanId",
          "featureId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<RatePlanFeature, 'id'>"
      },
      "RatePlanFeatureWithRelations": {
        "title": "RatePlanFeatureWithRelations",
        "type": "object",
        "description": "(tsType: RatePlanFeatureWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "ratePlanId",
          "featureId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "RatePlanFeatureWithRelations"
      },
      "RatePlanFeaturePartialExcluding_id_": {
        "title": "RatePlanFeaturePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<RatePlanFeature>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "ratePlanId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<RatePlanFeature>, 'id'>"
      },
      "Account": {
        "title": "Account",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "zipCode": {
            "type": "string"
          },
          "gstin": {
            "type": "string",
            "description": "Customer GSTIN (15 characters); its first two digits are the state code.",
            "nullable": true,
            "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z]Z[0-9A-Z]$",
            "maxLength": 15
          },
          "stateCode": {
            "type": "string",
            "description": "GST state code of the bill-to state (derived from the GSTIN when blank).",
            "nullable": true,
            "pattern": "^[0-9]{2}$"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "accountType": {
            "type": "string",
            "enum": [
              "Organisation",
              "Individual"
            ]
          },
          "parentAccountId": {
            "type": "string",
            "format": "uuid"
          },
          "sameAsSoldTo": {
            "type": "boolean"
          },
          "soldToId": {
            "type": "string",
            "format": "uuid"
          },
          "billToId": {
            "type": "string",
            "format": "uuid"
          },
          "autoPay": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "balance": {
            "type": "number"
          },
          "mrr": {
            "type": "number"
          },
          "netTermDays": {
            "type": "number"
          },
          "createdOn": {
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "In Trial",
              "Active",
              "Inactive",
              "Dormant"
            ]
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "phone",
          "email",
          "sameAsSoldTo",
          "status"
        ],
        "additionalProperties": false
      },
      "AccountContact": {
        "title": "AccountContact",
        "type": "object",
        "properties": {
          "contactId": {
            "type": "string",
            "format": "uuid"
          },
          "fullName": {
            "type": "string"
          },
          "orgName": {
            "type": "string",
            "description": "Mandatory if accountType is Organization. As its name suggests, it is name of the organisation."
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "fullName",
          "phone",
          "email"
        ],
        "additionalProperties": false
      },
      "New1AccountInfo": {
        "title": "New1AccountInfo",
        "type": "object",
        "description": "(tsType: Omit<AccountInfo, 'accountId' | 'tenantId'>, schemaOptions: { title: 'New1AccountInfo', exclude: [ 'accountId', 'tenantId' ] })",
        "properties": {
          "name": {
            "type": "string",
            "description": "Optional <br>Name of the account. It will be organization name if accountType is \"Organisation\" and concatenation of first name and last name if accountType is \"Individual\""
          },
          "address": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "zipCode": {
            "type": "string"
          },
          "gstin": {
            "type": "string",
            "description": "Customer GSTIN (15 characters); its first two digits are the state code.",
            "nullable": true,
            "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z]Z[0-9A-Z]$",
            "maxLength": 15
          },
          "stateCode": {
            "type": "string",
            "description": "GST state code of the bill-to state (derived from the GSTIN when blank).",
            "nullable": true,
            "pattern": "^[0-9]{2}$"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "description": "root email id of the user."
          },
          "accountType": {
            "type": "string",
            "description": "Represents the type of customer.",
            "enum": [
              "Organisation",
              "Individual"
            ]
          },
          "parentAccountId": {
            "type": "string",
            "description": "Optional <br>In an account hierarchy, the parent account ID refers to the unique identifier of the account that is considered the parent or superior account in the hierarchy. It represents the relationship between different accounts within a hierarchical structure.",
            "format": "uuid"
          },
          "communicationProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "sameAsSoldTo": {
            "type": "boolean",
            "description": "Set to true if billing contact is same as sold to contact otherwise false."
          },
          "billingProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "autoPay": {
            "type": "boolean",
            "description": "Optional <br>Auto Pay refers to the automatic collection of payment for a subscription or service.<br>Default value: false"
          },
          "currency": {
            "type": "string",
            "description": "Preferred currency customer would like to deal in. <br>Not mandatory to create a customer but it should be updated before subscription to any service.",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "balance": {
            "type": "number",
            "description": "Balance of the account"
          },
          "mrr": {
            "type": "number"
          },
          "netTermDays": {
            "type": "number",
            "description": "Optional <br>Net term days, also known as payment terms or credit terms, refer to the number of days a buyer has to pay an invoice or outstanding balance to a seller or vendor. It specifies the timeframe within which payment is expected to be made after the delivery of goods or completion of services."
          },
          "createdOn": {
            "type": "string",
            "description": "Timestamp when customer is created. No need to mention as system automatically capture this.",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "description": "Represents current status of customer.",
            "enum": [
              "Draft",
              "In Trial",
              "Active",
              "Inactive",
              "Dormant"
            ]
          }
        },
        "required": [
          "phone",
          "email"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<AccountInfo, 'accountId' | 'tenantId'>"
      },
      "AccountInfo": {
        "title": "AccountInfo",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "description": "Unique Identifier of customer",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Optional <br>Name of the account. It will be organization name if accountType is \"Organisation\" and concatenation of first name and last name if accountType is \"Individual\""
          },
          "address": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "zipCode": {
            "type": "string"
          },
          "gstin": {
            "type": "string",
            "description": "Customer GSTIN (15 characters); its first two digits are the state code.",
            "nullable": true,
            "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z]Z[0-9A-Z]$",
            "maxLength": 15
          },
          "stateCode": {
            "type": "string",
            "description": "GST state code of the bill-to state (derived from the GSTIN when blank).",
            "nullable": true,
            "pattern": "^[0-9]{2}$"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "description": "root email id of the user."
          },
          "accountType": {
            "type": "string",
            "description": "Represents the type of customer.",
            "enum": [
              "Organisation",
              "Individual"
            ]
          },
          "parentAccountId": {
            "type": "string",
            "description": "Optional <br>In an account hierarchy, the parent account ID refers to the unique identifier of the account that is considered the parent or superior account in the hierarchy. It represents the relationship between different accounts within a hierarchical structure.",
            "format": "uuid"
          },
          "communicationProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "sameAsSoldTo": {
            "type": "boolean",
            "description": "Set to true if billing contact is same as sold to contact otherwise false."
          },
          "billingProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "autoPay": {
            "type": "boolean",
            "description": "Optional <br>Auto Pay refers to the automatic collection of payment for a subscription or service.<br>Default value: false"
          },
          "currency": {
            "type": "string",
            "description": "Preferred currency customer would like to deal in. <br>Not mandatory to create a customer but it should be updated before subscription to any service.",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "balance": {
            "type": "number",
            "description": "Balance of the account"
          },
          "mrr": {
            "type": "number"
          },
          "netTermDays": {
            "type": "number",
            "description": "Optional <br>Net term days, also known as payment terms or credit terms, refer to the number of days a buyer has to pay an invoice or outstanding balance to a seller or vendor. It specifies the timeframe within which payment is expected to be made after the delivery of goods or completion of services."
          },
          "createdOn": {
            "type": "string",
            "description": "Timestamp when customer is created. No need to mention as system automatically capture this.",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "description": "Represents current status of customer.",
            "enum": [
              "Draft",
              "In Trial",
              "Active",
              "Inactive",
              "Dormant"
            ]
          }
        },
        "required": [
          "tenantId",
          "phone",
          "email"
        ],
        "additionalProperties": false
      },
      "PaymentGatewayMetadataWithRelations": {
        "title": "PaymentGatewayMetadataWithRelations",
        "type": "object",
        "description": "(tsType: PaymentGatewayMetadataWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "paymentGateway": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "cards": {
            "type": "boolean"
          },
          "netBanking": {
            "type": "boolean"
          },
          "upi": {
            "type": "boolean"
          },
          "bankTransfer": {
            "type": "boolean"
          },
          "sepaDirectDebit": {
            "type": "boolean"
          },
          "achDebit": {
            "type": "boolean"
          },
          "amazonPay": {
            "type": "boolean"
          },
          "paypal": {
            "type": "boolean"
          },
          "applePay": {
            "type": "boolean"
          }
        },
        "required": [
          "paymentGateway",
          "cards",
          "netBanking",
          "upi",
          "bankTransfer",
          "sepaDirectDebit",
          "achDebit",
          "amazonPay",
          "paypal",
          "applePay"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PaymentGatewayMetadataWithRelations"
      },
      "RatePlanPriceViewDetailsWithRelations": {
        "title": "RatePlanPriceViewDetailsWithRelations",
        "type": "object",
        "description": "(tsType: RatePlanPriceViewDetailsWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "ratePlanId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "ratePlanKey": {
            "type": "string",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          },
          "productId": {
            "type": "string",
            "nullable": true
          },
          "productName": {
            "type": "string"
          },
          "isVisibleInCheckout": {
            "type": "boolean",
            "nullable": true
          },
          "redirectUrl": {
            "type": "string",
            "nullable": true
          },
          "planLevel": {
            "type": "number",
            "nullable": true
          },
          "mostPopular": {
            "type": "boolean",
            "nullable": true
          },
          "ratePlanPriceId": {
            "type": "string",
            "nullable": true
          },
          "isTrial": {
            "type": "boolean",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "customerDescription": {
            "type": "string",
            "nullable": true
          },
          "requireBillingAtSignup": {
            "type": "boolean",
            "nullable": true
          },
          "autoRenew": {
            "type": "boolean",
            "nullable": true
          },
          "termLength": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "mrr": {
            "type": "number",
            "nullable": true
          },
          "trialPeriod": {
            "$ref": "#/components/schemas/Period"
          },
          "billingPeriod": {
            "$ref": "#/components/schemas/Period"
          },
          "isAutoCalculated": {
            "type": "boolean",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "pricingModel": {
            "type": "string",
            "nullable": true
          },
          "ratePlanPriceKey": {
            "type": "string",
            "nullable": true
          },
          "freeQuantity": {
            "type": "number",
            "nullable": true
          },
          "billingCycle": {
            "type": "string",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": true
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "highlightPlan": {
            "type": "boolean",
            "nullable": false
          },
          "showStrikethrough": {
            "type": "boolean",
            "nullable": false
          },
          "strikethroughPrice": {
            "type": "number",
            "nullable": false
          },
          "showPrice": {
            "type": "boolean",
            "nullable": false
          },
          "ctaButtonBehavior": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Open Checkout",
              "Redirect To Url"
            ]
          },
          "ctaButtonLabel": {
            "type": "string",
            "nullable": true
          },
          "customBadge": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean",
            "nullable": true
          },
          "creditPacks": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": true
            }
          },
          "grantAmount": {
            "type": "number",
            "nullable": true
          },
          "grantFrequency": {
            "type": "string",
            "enum": [
              "ONCE",
              "EVERY_PERIOD",
              null
            ],
            "nullable": true
          },
          "rollover": {
            "type": "boolean",
            "nullable": true
          },
          "creditExpiryDays": {
            "type": "number",
            "nullable": true
          },
          "walletZeroBalanceAction": {
            "type": "string",
            "enum": [
              "BILL_OVERAGE",
              "AUTO_TOP_UP",
              "BLOCK",
              null
            ],
            "nullable": true
          },
          "autoTopUpPack": {
            "type": "number",
            "nullable": true
          },
          "autoTopUpThreshold": {
            "type": "number",
            "nullable": true
          },
          "commitmentAmount": {
            "type": "number",
            "nullable": true
          },
          "commitmentPeriod": {
            "type": "string",
            "enum": [
              "BILLING_PERIOD",
              "CONTRACT",
              null
            ],
            "nullable": true
          },
          "charges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanChargeView"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RatePlanPriceAddonPriceView"
            }
          }
        },
        "required": [
          "productName"
        ],
        "additionalProperties": false,
        "x-typescript-type": "RatePlanPriceViewDetailsWithRelations"
      },
      "Product": {
        "title": "Product",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "effectiveFromDate": {
            "type": "string",
            "format": "date"
          },
          "effectiveToDate": {
            "type": "string",
            "format": "date"
          },
          "logoPath": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "hsnSacCode": {
            "type": "string",
            "description": "HSN (goods) or SAC (services) code printed on tax invoices.",
            "nullable": true,
            "pattern": "^[0-9]{4,8}$"
          },
          "gstRate": {
            "type": "number",
            "description": "GST percentage for this product: 0, 0.25, 3, 5, 12, 18 or 28. Empty means the tenant default applies.",
            "nullable": true,
            "minimum": 0,
            "maximum": 28
          }
        },
        "required": [
          "name",
          "effectiveFromDate",
          "status"
        ],
        "additionalProperties": false
      },
      "NewProduct": {
        "title": "NewProduct",
        "type": "object",
        "description": "(tsType: Omit<Product, 'tenantId' | 'effectiveFromDate' | 'effectiveToDate' | 'status'>, schemaOptions: { title: 'NewProduct', exclude: [ 'tenantId', 'effectiveFromDate', 'effectiveToDate', 'status' ] })",
        "properties": {
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "logoPath": {
            "type": "string"
          },
          "hsnSacCode": {
            "type": "string",
            "description": "HSN (goods) or SAC (services) code printed on tax invoices.",
            "nullable": true,
            "pattern": "^[0-9]{4,8}$"
          },
          "gstRate": {
            "type": "number",
            "description": "GST percentage for this product: 0, 0.25, 3, 5, 12, 18 or 28. Empty means the tenant default applies.",
            "nullable": true,
            "minimum": 0,
            "maximum": 28
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Product, 'tenantId' | 'effectiveFromDate' | 'effectiveToDate' | 'status'>"
      },
      "ProductWithRelations": {
        "title": "ProductWithRelations",
        "type": "object",
        "description": "(tsType: ProductWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "effectiveFromDate": {
            "type": "string",
            "format": "date"
          },
          "effectiveToDate": {
            "type": "string",
            "format": "date"
          },
          "logoPath": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "hsnSacCode": {
            "type": "string",
            "description": "HSN (goods) or SAC (services) code printed on tax invoices.",
            "nullable": true,
            "pattern": "^[0-9]{4,8}$"
          },
          "gstRate": {
            "type": "number",
            "description": "GST percentage for this product: 0, 0.25, 3, 5, 12, 18 or 28. Empty means the tenant default applies.",
            "nullable": true,
            "minimum": 0,
            "maximum": 28
          }
        },
        "required": [
          "name",
          "effectiveFromDate",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "ProductWithRelations"
      },
      "ProductPartial": {
        "title": "ProductPartial",
        "type": "object",
        "description": "(tsType: Partial<Product>, schemaOptions: { partial: true })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "effectiveFromDate": {
            "type": "string",
            "format": "date"
          },
          "effectiveToDate": {
            "type": "string",
            "format": "date"
          },
          "logoPath": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "hsnSacCode": {
            "type": "string",
            "description": "HSN (goods) or SAC (services) code printed on tax invoices.",
            "nullable": true,
            "pattern": "^[0-9]{4,8}$"
          },
          "gstRate": {
            "type": "number",
            "description": "GST percentage for this product: 0, 0.25, 3, 5, 12, 18 or 28. Empty means the tenant default applies.",
            "nullable": true,
            "minimum": 0,
            "maximum": 28
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<Product>"
      },
      "Payment": {
        "title": "Payment",
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "requestedAmount": {
            "type": "number"
          },
          "amountPaid": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "INITIALIZED",
              "PAID",
              "EXPIRED",
              "PARTIALLY_PAID",
              "PENDING",
              "FAILED",
              "CANCELLED"
            ]
          },
          "acceptPartial": {
            "type": "boolean"
          },
          "expireBy": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "customer": {
            "type": "object"
          },
          "paymentLink": {
            "type": "string"
          },
          "paymentLinkId": {
            "type": "string"
          },
          "referenceId": {
            "type": "string"
          },
          "updateTs": {
            "type": "string",
            "format": "date-time"
          },
          "transactionId": {
            "type": "string"
          },
          "paymentMethod": {
            "type": "string",
            "enum": [
              "ACH",
              "ENACH",
              "Upi Autopay",
              "Cash",
              "CC Reference Transaction",
              "Cheque",
              "Wire Transfer",
              "Card",
              "UPI",
              "Wallet",
              "Net Banking"
            ]
          },
          "paymentDetails": {
            "type": "object"
          },
          "paymentDate": {
            "type": "string",
            "format": "date"
          }
        },
        "required": [
          "amountPaid",
          "currency",
          "status"
        ],
        "additionalProperties": false
      },
      "NewPayment": {
        "title": "NewPayment",
        "type": "object",
        "description": "(tsType: Omit<Payment, 'paymentId' | 'tenantId'>, schemaOptions: { title: 'NewPayment', exclude: [ 'paymentId', 'tenantId' ] })",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "requestedAmount": {
            "type": "number"
          },
          "amountPaid": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "INITIALIZED",
              "PAID",
              "EXPIRED",
              "PARTIALLY_PAID",
              "PENDING",
              "FAILED",
              "CANCELLED"
            ]
          },
          "acceptPartial": {
            "type": "boolean"
          },
          "expireBy": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "customer": {
            "type": "object"
          },
          "paymentLink": {
            "type": "string"
          },
          "paymentLinkId": {
            "type": "string"
          },
          "referenceId": {
            "type": "string"
          },
          "updateTs": {
            "type": "string",
            "format": "date-time"
          },
          "transactionId": {
            "type": "string"
          },
          "paymentMethod": {
            "type": "string",
            "enum": [
              "ACH",
              "ENACH",
              "Upi Autopay",
              "Cash",
              "CC Reference Transaction",
              "Cheque",
              "Wire Transfer",
              "Card",
              "UPI",
              "Wallet",
              "Net Banking"
            ]
          },
          "paymentDetails": {
            "type": "object"
          },
          "paymentDate": {
            "type": "string",
            "format": "date"
          }
        },
        "required": [
          "amountPaid",
          "currency",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Payment, 'paymentId' | 'tenantId'>"
      },
      "PaymentWithRelations": {
        "title": "PaymentWithRelations",
        "type": "object",
        "description": "(tsType: PaymentWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "paymentId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "requestedAmount": {
            "type": "number"
          },
          "amountPaid": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "INITIALIZED",
              "PAID",
              "EXPIRED",
              "PARTIALLY_PAID",
              "PENDING",
              "FAILED",
              "CANCELLED"
            ]
          },
          "acceptPartial": {
            "type": "boolean"
          },
          "expireBy": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "customer": {
            "type": "object"
          },
          "paymentLink": {
            "type": "string"
          },
          "paymentLinkId": {
            "type": "string"
          },
          "referenceId": {
            "type": "string"
          },
          "updateTs": {
            "type": "string",
            "format": "date-time"
          },
          "transactionId": {
            "type": "string"
          },
          "paymentMethod": {
            "type": "string",
            "enum": [
              "ACH",
              "ENACH",
              "Upi Autopay",
              "Cash",
              "CC Reference Transaction",
              "Cheque",
              "Wire Transfer",
              "Card",
              "UPI",
              "Wallet",
              "Net Banking"
            ]
          },
          "paymentDetails": {
            "type": "object"
          },
          "paymentDate": {
            "type": "string",
            "format": "date"
          }
        },
        "required": [
          "amountPaid",
          "currency",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PaymentWithRelations"
      },
      "PaymentMethodMasterWithRelations": {
        "title": "PaymentMethodMasterWithRelations",
        "type": "object",
        "description": "(tsType: PaymentMethodMasterWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "methodId": {
            "type": "string",
            "format": "uuid"
          },
          "methodName": {
            "type": "string"
          },
          "methodCode": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "methodName",
          "methodCode",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PaymentMethodMasterWithRelations"
      },
      "PaymentGatewaySetting": {
        "title": "PaymentGatewaySetting",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "paymentGateway": {
            "type": "string",
            "enum": [
              "RazorPay",
              "Authorize.net",
              "Cashfree"
            ]
          },
          "credentials": {
            "type": "object"
          },
          "paymentGatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "successCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "successCallbackUrl": {
            "type": "string"
          },
          "failCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "failCallbackUrl": {
            "type": "string"
          }
        },
        "required": [
          "tenantId",
          "paymentGateway",
          "credentials"
        ],
        "additionalProperties": false
      },
      "NewPaymentGatewaySetting": {
        "title": "NewPaymentGatewaySetting",
        "type": "object",
        "description": "(tsType: Omit<PaymentGatewaySetting, 'paymentGatewayId' | 'tenantId'>, schemaOptions: { title: 'NewPaymentGatewaySetting', exclude: [ 'paymentGatewayId', 'tenantId' ] })",
        "properties": {
          "paymentGateway": {
            "type": "string",
            "enum": [
              "RazorPay",
              "Authorize.net",
              "Cashfree"
            ]
          },
          "credentials": {
            "type": "object"
          },
          "successCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "successCallbackUrl": {
            "type": "string"
          },
          "failCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "failCallbackUrl": {
            "type": "string"
          }
        },
        "required": [
          "paymentGateway",
          "credentials"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<PaymentGatewaySetting, 'paymentGatewayId' | 'tenantId'>"
      },
      "PaymentGatewaySettingWithRelations": {
        "title": "PaymentGatewaySettingWithRelations",
        "type": "object",
        "description": "(tsType: PaymentGatewaySettingWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "paymentGateway": {
            "type": "string",
            "enum": [
              "RazorPay",
              "Authorize.net",
              "Cashfree"
            ]
          },
          "credentials": {
            "type": "object"
          },
          "paymentGatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "successCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "successCallbackUrl": {
            "type": "string"
          },
          "failCallbackMethod": {
            "type": "string",
            "enum": [
              "get",
              "post",
              "put",
              "delete"
            ]
          },
          "failCallbackUrl": {
            "type": "string"
          }
        },
        "required": [
          "tenantId",
          "paymentGateway",
          "credentials"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PaymentGatewaySettingWithRelations"
      },
      "MerchantBusinessDetails": {
        "title": "MerchantBusinessDetails",
        "type": "object",
        "properties": {
          "business_type": {
            "type": "string",
            "enum": [
              "Individual",
              "Proprietorship",
              "LLP",
              "Partnership",
              "Private Limited",
              "Public Limited",
              "Trust",
              "Society",
              "NGO",
              "Hindu Undivided Family (HUF)",
              "Association of Persons (AOP)",
              "Body of Individuals (BOI)",
              "Local Authority",
              "Artificial Juridical Person",
              "Government"
            ]
          },
          "business_model": {
            "type": "string",
            "enum": [
              "B2C",
              "B2B",
              "Both"
            ]
          },
          "business_category": {
            "type": "string"
          },
          "business_sub_category": {
            "type": "string"
          },
          "business_registered_address": {
            "type": "string"
          },
          "business_registered_address_pincode": {
            "type": "string"
          },
          "business_operation_address": {
            "type": "string"
          },
          "business_operation_address_pincode": {
            "type": "string"
          },
          "iec": {
            "type": "string"
          },
          "gstin": {
            "type": "string"
          },
          "cin": {
            "type": "string"
          },
          "pan": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantWebsiteDetails": {
        "title": "MerchantWebsiteDetails",
        "type": "object",
        "properties": {
          "website_about_us": {
            "type": "string"
          },
          "website_contact_us": {
            "type": "string"
          },
          "website_pricing_details": {
            "type": "string"
          },
          "website_refund_policy": {
            "type": "string"
          },
          "website_terms_and_conditions": {
            "type": "string"
          },
          "website_privacy_policy": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantBankAccountDetails": {
        "title": "MerchantBankAccountDetails",
        "type": "object",
        "properties": {
          "account_holder_name": {
            "type": "string"
          },
          "account_number": {
            "type": "string"
          },
          "ifsc": {
            "type": "string"
          },
          "bank_name": {
            "type": "string"
          },
          "branch_name": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantSignatoryDetails": {
        "title": "MerchantSignatoryDetails",
        "type": "object",
        "properties": {
          "signatory_name": {
            "type": "string"
          },
          "signatory_email": {
            "type": "string"
          },
          "signatory_phone": {
            "type": "string"
          },
          "signatory_pan": {
            "type": "string"
          },
          "signatory_aadhaar": {
            "type": "string"
          },
          "signatory_address": {
            "type": "string"
          },
          "signatory_dob": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantAdditionalDetails": {
        "title": "MerchantAdditionalDetails",
        "type": "object",
        "properties": {
          "mcc": {
            "type": "string"
          },
          "annual_turnover": {
            "type": "string"
          },
          "average_monthly_transaction_value": {
            "type": "string"
          },
          "average_ticket_size": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantProductStatus": {
        "title": "MerchantProductStatus",
        "type": "object",
        "properties": {
          "product": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "settlement_status": {
            "type": "string"
          },
          "product_name": {
            "type": "string"
          },
          "product_min_kyc_status": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MerchantResponse": {
        "title": "MerchantResponse",
        "type": "object",
        "properties": {
          "merchant_id": {
            "type": "string"
          },
          "merchant_email": {
            "type": "string"
          },
          "merchant_name": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "onboarding_status": {
            "type": "string"
          },
          "poc_phone": {
            "type": "string"
          },
          "merchant_site_url": {
            "type": "string"
          },
          "business_details": {
            "$ref": "#/components/schemas/MerchantBusinessDetails"
          },
          "website_details": {
            "$ref": "#/components/schemas/MerchantWebsiteDetails"
          },
          "bank_account_details": {
            "$ref": "#/components/schemas/MerchantBankAccountDetails"
          },
          "signatory_details": {
            "$ref": "#/components/schemas/MerchantSignatoryDetails"
          },
          "additional_details": {
            "$ref": "#/components/schemas/MerchantAdditionalDetails"
          },
          "product_status": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MerchantProductStatus"
            }
          }
        },
        "additionalProperties": false
      },
      "CreateMerchantRequest": {
        "title": "CreateMerchantRequest",
        "type": "object",
        "properties": {
          "merchant_id": {
            "type": "string"
          },
          "merchant_email": {
            "type": "string"
          },
          "merchant_name": {
            "type": "string"
          },
          "poc_phone": {
            "type": "string"
          },
          "merchant_site_url": {
            "type": "string"
          },
          "business_details": {
            "$ref": "#/components/schemas/MerchantBusinessDetails"
          },
          "website_details": {
            "$ref": "#/components/schemas/MerchantWebsiteDetails"
          },
          "bank_account_details": {
            "$ref": "#/components/schemas/MerchantBankAccountDetails"
          },
          "signatory_details": {
            "$ref": "#/components/schemas/MerchantSignatoryDetails"
          },
          "additional_details": {
            "$ref": "#/components/schemas/MerchantAdditionalDetails"
          }
        },
        "required": [
          "merchant_id",
          "merchant_email",
          "merchant_name",
          "poc_phone",
          "merchant_site_url"
        ],
        "additionalProperties": false
      },
      "OnboardingLinkResponse": {
        "title": "OnboardingLinkResponse",
        "type": "object",
        "properties": {
          "onboarding_link": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "TenantBusinessProfile": {
        "title": "TenantBusinessProfile",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "brandName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 100
          },
          "legalName": {
            "type": "string",
            "nullable": true,
            "maxLength": 150
          },
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 150
          },
          "phone": {
            "type": "string",
            "pattern": "^\\+?[0-9]{10,15}$"
          },
          "websiteUrl": {
            "type": "string",
            "pattern": "^https?://",
            "maxLength": 255
          },
          "businessType": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "businessModel": {
            "type": "string",
            "nullable": true,
            "maxLength": 20
          },
          "category": {
            "type": "string",
            "nullable": true,
            "maxLength": 100
          },
          "subCategory": {
            "type": "string",
            "nullable": true,
            "maxLength": 100
          },
          "address": {
            "type": "string",
            "nullable": true,
            "maxLength": 255
          },
          "city": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "state": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "postalCode": {
            "type": "string",
            "nullable": true,
            "maxLength": 10
          },
          "country": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "gstin": {
            "type": "string",
            "nullable": true,
            "pattern": "^$|^[0-9A-Z]{15}$"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "tenantId",
          "brandName",
          "email",
          "phone",
          "websiteUrl"
        ],
        "additionalProperties": false
      },
      "TenantBusinessProfileInput": {
        "title": "TenantBusinessProfileInput",
        "type": "object",
        "description": "(tsType: Omit<TenantBusinessProfile, 'tenantId' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'TenantBusinessProfileInput', exclude: [ 'tenantId', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "brandName": {
            "type": "string",
            "minLength": 2,
            "maxLength": 100
          },
          "legalName": {
            "type": "string",
            "nullable": true,
            "maxLength": 150
          },
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 150
          },
          "phone": {
            "type": "string",
            "pattern": "^\\+?[0-9]{10,15}$"
          },
          "websiteUrl": {
            "type": "string",
            "pattern": "^https?://",
            "maxLength": 255
          },
          "businessType": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "businessModel": {
            "type": "string",
            "nullable": true,
            "maxLength": 20
          },
          "category": {
            "type": "string",
            "nullable": true,
            "maxLength": 100
          },
          "subCategory": {
            "type": "string",
            "nullable": true,
            "maxLength": 100
          },
          "address": {
            "type": "string",
            "nullable": true,
            "maxLength": 255
          },
          "city": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "state": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "postalCode": {
            "type": "string",
            "nullable": true,
            "maxLength": 10
          },
          "country": {
            "type": "string",
            "nullable": true,
            "maxLength": 50
          },
          "gstin": {
            "type": "string",
            "nullable": true,
            "pattern": "^$|^[0-9A-Z]{15}$"
          }
        },
        "required": [
          "brandName",
          "email",
          "phone",
          "websiteUrl"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<TenantBusinessProfile, 'tenantId' | 'createdTs' | 'updatedTs'>"
      },
      "PaymentGatewayOnboardingState": {
        "title": "PaymentGatewayOnboardingState",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "pgCode": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "payment_gateway.status (Active only once onboarding is ACTIVE)"
          },
          "onboardingStatus": {
            "type": "string",
            "enum": [
              "NOT_STARTED",
              "INVITED",
              "EMAIL_PENDING",
              "KYC_PENDING",
              "KYC_SUBMITTED",
              "ACTION_REQUIRED",
              "ACTIVE",
              "SUSPENDED",
              "FAILED"
            ]
          },
          "statusReason": {
            "type": "string"
          },
          "externalAccountId": {
            "type": "string"
          },
          "activatedAt": {
            "type": "string"
          },
          "lastSyncedAt": {
            "type": "string"
          },
          "duplicate": {
            "type": "boolean",
            "description": "Webhook only: true when the event was already processed"
          }
        },
        "additionalProperties": false
      },
      "OnboardingSessionResponse": {
        "title": "OnboardingSessionResponse",
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "expiresAt": {
            "type": "string"
          }
        },
        "required": [
          "url"
        ],
        "additionalProperties": false
      },
      "PaymentGatewayMaster": {
        "title": "PaymentGatewayMaster",
        "type": "object",
        "properties": {
          "gatewayName": {
            "type": "string",
            "nullable": false
          },
          "gatewayId": {
            "type": "string",
            "nullable": false
          },
          "gatewayCode": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": false
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "supportedCurrencies": {
            "type": "string",
            "nullable": true
          },
          "apiKey": {
            "type": "string",
            "nullable": false
          },
          "apiSecret": {
            "type": "string",
            "nullable": false
          },
          "externalAccountId": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "gatewayName",
          "gatewayId",
          "status",
          "createdTs",
          "updatedTs",
          "apiKey",
          "apiSecret"
        ],
        "additionalProperties": false
      },
      "PaymentGatewayMastersWithRelations": {
        "title": "PaymentGatewayMastersWithRelations",
        "type": "object",
        "description": "(tsType: PaymentGatewayMastersWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "paymentGateways": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentGatewayMaster"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "PaymentGatewayMastersWithRelations"
      },
      "OrderSummary": {
        "title": "OrderSummary",
        "type": "object",
        "properties": {
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "currency": {
            "type": "string"
          },
          "subtotal": {
            "type": "number"
          },
          "discount": {
            "type": "number"
          },
          "tax": {
            "type": "number",
            "description": "GST on the order. In EXCLUSIVE pricing it is added to total; in INCLUSIVE pricing it is already inside subtotal (see gst.mode)."
          },
          "gst": {
            "type": "object",
            "description": "GST breakdown: pricing mode, supply type, place of supply, GSTINs, CGST/SGST/IGST and the per-line rate and HSN/SAC."
          },
          "total": {
            "type": "number"
          },
          "credits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "debits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "dueAmount": {
            "type": "number"
          },
          "creditCarriedForward": {
            "type": "number",
            "description": "Credit left over after the charge; carried forward to later invoices."
          },
          "contractTerms": {
            "type": "object",
            "description": "CANCEL_SUBSCRIPTION only: contract terms, notice period and the early-termination fee (also a line in cart)."
          },
          "effectiveDate": {
            "type": "string",
            "description": "CHANGE_PLAN / FREQUENCY_CHANGE estimate: the day the change takes effect (YYYY-MM-DD)."
          },
          "billedOn": {
            "type": "string",
            "description": "CHANGE_PLAN / FREQUENCY_CHANGE estimate: the day it is billed (YYYY-MM-DD); the renewal invoice date for a same-period End of Term change."
          }
        },
        "required": [
          "cart",
          "subtotal",
          "discount",
          "tax",
          "total",
          "dueAmount"
        ],
        "additionalProperties": false
      },
      "NewOrderData": {
        "title": "NewOrderData",
        "type": "object",
        "description": "(tsType: OrderData, schemaOptions: { title: 'NewOrderData' })",
        "properties": {
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "eventType": {
            "type": "string",
            "enum": [
              "NEW SUBSCRIPTION",
              "TRIAL ACTIVATION",
              "ADD ADDON",
              "PAUSE SUBSCRIPTION",
              "RESUME SUBSCRIPTION",
              "CANCEL SUBSCRIPTION",
              "EXPIRE SUBSCRIPTION",
              "RENEW SUBSCRIPTION",
              "REACTIVATE SUBSCRIPTION",
              "CHANGE PLAN",
              "FREQUENCY CHANGE",
              "WALLET TOP-UP"
            ]
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "paymentDetails": {
            "$ref": "#/components/schemas/PaymentDetails"
          },
          "cart": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CartItem"
            }
          },
          "personalInfo": {
            "$ref": "#/components/schemas/PersonalInfo"
          },
          "subscriptionId": {
            "type": "string"
          },
          "options": {
            "type": "object"
          },
          "workflowProcessInstanceId": {
            "type": "string",
            "description": "Camunda workflow process instance ID for tracking"
          }
        },
        "required": [
          "srcSysCode",
          "eventType",
          "currency",
          "cart"
        ],
        "additionalProperties": false,
        "x-typescript-type": "OrderData"
      },
      "Order": {
        "title": "Order",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "scheduleDate": {
            "type": "string",
            "format": "date"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "totalAmount": {
            "type": "number"
          },
          "dueAmount": {
            "type": "number"
          },
          "subTotal": {
            "type": "number"
          },
          "tax": {
            "type": "number"
          },
          "discount": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "Created",
              "Awaiting Mandate",
              "Payment Pending",
              "Processed Payment Pending",
              "Payment Received",
              "Invoiced",
              "Completed",
              "Cancelled",
              "Failed",
              "Refunded"
            ]
          },
          "srcSysCode": {
            "type": "string",
            "enum": [
              "BillHive Web App",
              "Self-Serve Portal",
              "Website",
              "API"
            ]
          },
          "eventType": {
            "type": "string",
            "enum": [
              "NEW SUBSCRIPTION",
              "TRIAL ACTIVATION",
              "ADD ADDON",
              "PAUSE SUBSCRIPTION",
              "RESUME SUBSCRIPTION",
              "CANCEL SUBSCRIPTION",
              "EXPIRE SUBSCRIPTION",
              "RENEW SUBSCRIPTION",
              "REACTIVATE SUBSCRIPTION",
              "CHANGE PLAN",
              "FREQUENCY CHANGE",
              "WALLET TOP-UP"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "salesRepId": {
            "type": "string",
            "format": "uuid"
          },
          "credits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "debits": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "options": {
            "type": "object"
          },
          "workflowProcessInstanceId": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "tenantId",
          "date",
          "accountId",
          "status",
          "srcSysCode",
          "eventType",
          "currency"
        ],
        "additionalProperties": false
      },
      "Orders": {
        "title": "Orders",
        "type": "object",
        "properties": {
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Order"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "Offer": {
        "title": "Offer",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Discount",
              "Coupon"
            ]
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "discountType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Percentage",
              "Custom Trial"
            ]
          },
          "currency": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "extendedTrialPeriod": {
            "type": "object",
            "nullable": true
          },
          "applyOn": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Invoice Amount",
              "Each Specified Item"
            ]
          },
          "discountDurationType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Forever",
              "Single Use",
              "Limited Time"
            ]
          },
          "discountDuration": {
            "type": "object",
            "nullable": true
          },
          "expiryDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "maxRedemptionLimit": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCount": {
            "type": "number",
            "nullable": true
          },
          "maxRedemptionLimitPerCustomer": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCountPerCustomer": {
            "type": "number",
            "nullable": true
          },
          "minimumPurchaseAmount": {
            "type": "number",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive",
              "Expired"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "tenantId",
          "type",
          "name",
          "discountType",
          "applyOn",
          "discountDurationType",
          "maxRedemptionLimit",
          "maxRedemptionLimitPerCustomer",
          "status",
          "createdTs",
          "updatedTs"
        ],
        "additionalProperties": false
      },
      "NewOffer": {
        "title": "NewOffer",
        "type": "object",
        "description": "(tsType: Omit<Offer, 'id' | 'status' | 'createdTs' | 'updatedTs' | 'tenantId'>, schemaOptions: { title: 'NewOffer', exclude: [ 'id', 'status', 'createdTs', 'updatedTs', 'tenantId' ] })",
        "properties": {
          "type": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Discount",
              "Coupon"
            ]
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "discountType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Percentage",
              "Custom Trial"
            ]
          },
          "currency": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "extendedTrialPeriod": {
            "type": "object",
            "nullable": true
          },
          "applyOn": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Invoice Amount",
              "Each Specified Item"
            ]
          },
          "discountDurationType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Forever",
              "Single Use",
              "Limited Time"
            ]
          },
          "discountDuration": {
            "type": "object",
            "nullable": true
          },
          "expiryDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "maxRedemptionLimit": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCount": {
            "type": "number",
            "nullable": true
          },
          "maxRedemptionLimitPerCustomer": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCountPerCustomer": {
            "type": "number",
            "nullable": true
          },
          "minimumPurchaseAmount": {
            "type": "number",
            "nullable": true
          }
        },
        "required": [
          "type",
          "name",
          "discountType",
          "applyOn",
          "discountDurationType",
          "maxRedemptionLimit",
          "maxRedemptionLimitPerCustomer"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Offer, 'id' | 'status' | 'createdTs' | 'updatedTs' | 'tenantId'>"
      },
      "OffersWithRelations": {
        "title": "OffersWithRelations",
        "type": "object",
        "description": "(tsType: OffersWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "offers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Offer"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "OffersWithRelations"
      },
      "OfferApplicabilityWithRelations": {
        "title": "OfferApplicabilityWithRelations",
        "type": "object",
        "description": "(tsType: OfferApplicabilityWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "offerId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "entity": {
            "type": "string",
            "nullable": false,
            "enum": [
              "RATE-PLAN",
              "ADDON",
              "CHARGE"
            ]
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "ALL",
              "NONE",
              "SPECIFIC",
              "CRITERIA"
            ]
          },
          "criteria": {
            "type": "object",
            "nullable": true
          }
        },
        "required": [
          "offerId",
          "entity",
          "applicability"
        ],
        "additionalProperties": false,
        "x-typescript-type": "OfferApplicabilityWithRelations"
      },
      "OfferPartialExcluding_id_": {
        "title": "OfferPartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Offer>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Discount",
              "Coupon"
            ]
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "discountType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Fixed",
              "Percentage",
              "Custom Trial"
            ]
          },
          "currency": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "extendedTrialPeriod": {
            "type": "object",
            "nullable": true
          },
          "applyOn": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Invoice Amount",
              "Each Specified Item"
            ]
          },
          "discountDurationType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Forever",
              "Single Use",
              "Limited Time"
            ]
          },
          "discountDuration": {
            "type": "object",
            "nullable": true
          },
          "expiryDate": {
            "type": "string",
            "format": "date",
            "nullable": false
          },
          "maxRedemptionLimit": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCount": {
            "type": "number",
            "nullable": true
          },
          "maxRedemptionLimitPerCustomer": {
            "type": "string",
            "nullable": false
          },
          "maxRedemptionCountPerCustomer": {
            "type": "number",
            "nullable": true
          },
          "minimumPurchaseAmount": {
            "type": "number",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive",
              "Expired"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Offer>, 'id'>"
      },
      "OfferApplicabilityResponse": {
        "title": "OfferApplicabilityResponse",
        "type": "object",
        "description": "(tsType: Omit<OfferLinkDetails, 'id'>, schemaOptions: { title: 'OfferApplicabilityResponse', exclude: [ 'id' ] })",
        "properties": {
          "offerId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "entity": {
            "type": "string",
            "nullable": false,
            "enum": [
              "RATE-PLAN",
              "ADDON",
              "CHARGE"
            ]
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "ALL",
              "NONE",
              "SPECIFIC",
              "CRITERIA"
            ]
          },
          "criteria": {
            "type": "object",
            "nullable": true
          },
          "ratePlanPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "addonPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "chargePriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          }
        },
        "required": [
          "offerId",
          "entity",
          "applicability"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OfferLinkDetails, 'id'>"
      },
      "NewOfferApplicability": {
        "title": "NewOfferApplicability",
        "type": "object",
        "description": "(tsType: Omit<OfferLinkDetails, 'id'>, schemaOptions: { title: 'NewOfferApplicability', exclude: [ 'id' ] })",
        "properties": {
          "offerId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "entity": {
            "type": "string",
            "nullable": false,
            "enum": [
              "RATE-PLAN",
              "ADDON",
              "CHARGE"
            ]
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "ALL",
              "NONE",
              "SPECIFIC",
              "CRITERIA"
            ]
          },
          "criteria": {
            "type": "object",
            "nullable": true
          },
          "ratePlanPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "addonPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "chargePriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          }
        },
        "required": [
          "offerId",
          "entity",
          "applicability"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<OfferLinkDetails, 'id'>"
      },
      "OfferLinkDetails": {
        "title": "OfferLinkDetails",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "offerId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "entity": {
            "type": "string",
            "nullable": false,
            "enum": [
              "RATE-PLAN",
              "ADDON",
              "CHARGE"
            ]
          },
          "applicability": {
            "type": "string",
            "nullable": false,
            "enum": [
              "ALL",
              "NONE",
              "SPECIFIC",
              "CRITERIA"
            ]
          },
          "criteria": {
            "type": "object",
            "nullable": true
          },
          "ratePlanPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "addonPriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          },
          "chargePriceIds": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "format": "uuid"
            }
          }
        },
        "required": [
          "offerId",
          "entity",
          "applicability"
        ],
        "additionalProperties": false
      },
      "EmailPreferenceWithRelations": {
        "title": "EmailPreferenceWithRelations",
        "type": "object",
        "description": "(tsType: EmailPreferenceWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "category": {
            "type": "string",
            "nullable": false
          },
          "emailType": {
            "type": "string",
            "nullable": false
          },
          "sendEmail": {
            "type": "boolean",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "tenantId",
          "category",
          "emailType",
          "sendEmail",
          "updatedTs"
        ],
        "additionalProperties": false,
        "x-typescript-type": "EmailPreferenceWithRelations"
      },
      "EmailPreferencePartial": {
        "title": "EmailPreferencePartial",
        "type": "object",
        "description": "(tsType: Partial<EmailPreference>, schemaOptions: { partial: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "category": {
            "type": "string",
            "nullable": false
          },
          "emailType": {
            "type": "string",
            "nullable": false
          },
          "sendEmail": {
            "type": "boolean",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<EmailPreference>"
      },
      "EmailPreference": {
        "title": "EmailPreference",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "tenantId": {
            "type": "string",
            "nullable": false
          },
          "category": {
            "type": "string",
            "nullable": false
          },
          "emailType": {
            "type": "string",
            "nullable": false
          },
          "sendEmail": {
            "type": "boolean",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "tenantId",
          "category",
          "emailType",
          "sendEmail",
          "updatedTs"
        ],
        "additionalProperties": false
      },
      "Receiver": {
        "title": "Receiver",
        "type": "object",
        "properties": {
          "to": {
            "type": "string"
          },
          "cc": {
            "type": "string"
          },
          "bcc": {
            "type": "string"
          }
        },
        "required": [
          "to"
        ],
        "additionalProperties": false
      },
      "Attachment": {
        "title": "Attachment",
        "type": "object",
        "properties": {
          "attachmentType": {
            "type": "string",
            "enum": [
              "URL",
              "String",
              "Encoded-string"
            ]
          },
          "filename": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "encoding": {
            "type": "string"
          },
          "bucket": {
            "type": "string"
          }
        },
        "required": [
          "attachmentType",
          "filename"
        ],
        "additionalProperties": false
      },
      "Notification": {
        "title": "Notification",
        "type": "object",
        "properties": {
          "notificationId": {
            "type": "string"
          },
          "sender": {
            "type": "string"
          },
          "subject": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "receiver": {
            "$ref": "#/components/schemas/Receiver"
          },
          "type": {
            "type": "string",
            "enum": [
              "PUSH",
              "EMAIL",
              "SMS"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "Pending",
              "Scheduled",
              "Rescheduled",
              "Delivered",
              "Failed",
              "Opened"
            ]
          },
          "tenantId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "sentTs": {
            "type": "string",
            "format": "date-time"
          },
          "plannedDate": {
            "type": "string",
            "format": "date"
          },
          "name": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          }
        },
        "required": [
          "sender",
          "receiver",
          "type",
          "tenantId"
        ],
        "additionalProperties": false
      },
      "NewNotification": {
        "title": "NewNotification",
        "type": "object",
        "description": "(tsType: Omit<Notification, 'notificationId' | 'sender' | 'status' | 'tenantId' | 'sentTs' | 'plannedDate'>, schemaOptions: { title: 'NewNotification', exclude: [ 'notificationId', 'sender', 'status', 'tenantId', 'sentTs', 'plannedDate' ] })",
        "properties": {
          "subject": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "receiver": {
            "$ref": "#/components/schemas/Receiver"
          },
          "type": {
            "type": "string",
            "enum": [
              "PUSH",
              "EMAIL",
              "SMS"
            ]
          },
          "accountId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          }
        },
        "required": [
          "receiver",
          "type"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Notification, 'notificationId' | 'sender' | 'status' | 'tenantId' | 'sentTs' | 'plannedDate'>"
      },
      "NotificationWithRelations": {
        "title": "NotificationWithRelations",
        "type": "object",
        "description": "(tsType: NotificationWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "notificationId": {
            "type": "string"
          },
          "sender": {
            "type": "string"
          },
          "subject": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "receiver": {
            "$ref": "#/components/schemas/Receiver"
          },
          "type": {
            "type": "string",
            "enum": [
              "PUSH",
              "EMAIL",
              "SMS"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "Pending",
              "Scheduled",
              "Rescheduled",
              "Delivered",
              "Failed",
              "Opened"
            ]
          },
          "tenantId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "sentTs": {
            "type": "string",
            "format": "date-time"
          },
          "plannedDate": {
            "type": "string",
            "format": "date"
          },
          "name": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Attachment"
            }
          }
        },
        "required": [
          "sender",
          "receiver",
          "type",
          "tenantId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "NotificationWithRelations"
      },
      "CreditMemo": {
        "title": "CreditMemo",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "Subscription Cancellation",
              "Plan Downgrade",
              "Failed Service Delivery",
              "Billing Error",
              "Promotions or Goodwill",
              "Partial Refunds",
              "Tax Adjustment",
              "Overpayment",
              "Free Trial Expired But Billed",
              "Wallet Top-up",
              "Wallet Bonus",
              "Wallet Grant",
              "Wallet Adjustment"
            ]
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amount": {
            "type": "number",
            "nullable": false
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "autoPost": {
            "type": "boolean",
            "nullable": false
          },
          "excludeFromAutoApplyRules": {
            "type": "boolean",
            "nullable": false
          },
          "comment": {
            "type": "string",
            "nullable": true
          },
          "effectiveDate": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Posted",
              "Cancelled"
            ]
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "creditNoteNumber": {
            "type": "string",
            "nullable": true
          },
          "originalInvoiceId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "originalInvoiceDate": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "taxRate": {
            "type": "number",
            "nullable": true
          },
          "supplyType": {
            "type": "string",
            "nullable": true
          },
          "scope": {
            "type": "string",
            "enum": [
              "Subscription",
              "Account"
            ]
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true
          },
          "customerGstin": {
            "type": "string",
            "nullable": true
          },
          "lineItems": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": true
            }
          },
          "wallet": {
            "type": "boolean",
            "nullable": false
          },
          "expiresOn": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "grantPeriodStart": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "grantPeriodEnd": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "transferredFromSubscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "required": [
          "sourceType",
          "accountId",
          "currency",
          "amount",
          "balance",
          "autoPost",
          "excludeFromAutoApplyRules",
          "status",
          "tenantId",
          "subscriptionId"
        ],
        "additionalProperties": false
      },
      "NewCreditMemo": {
        "title": "NewCreditMemo",
        "type": "object",
        "description": "(tsType: Omit<CreditMemo, 'id' | 'tenantId'>, schemaOptions: { title: 'NewCreditMemo', exclude: [ 'id', 'tenantId' ] })",
        "properties": {
          "sourceType": {
            "type": "string",
            "enum": [
              "Subscription Cancellation",
              "Plan Downgrade",
              "Failed Service Delivery",
              "Billing Error",
              "Promotions or Goodwill",
              "Partial Refunds",
              "Tax Adjustment",
              "Overpayment",
              "Free Trial Expired But Billed",
              "Wallet Top-up",
              "Wallet Bonus",
              "Wallet Grant",
              "Wallet Adjustment"
            ]
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amount": {
            "type": "number",
            "nullable": false
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "autoPost": {
            "type": "boolean",
            "nullable": false
          },
          "excludeFromAutoApplyRules": {
            "type": "boolean",
            "nullable": false
          },
          "comment": {
            "type": "string",
            "nullable": true
          },
          "effectiveDate": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Posted",
              "Cancelled"
            ]
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "creditNoteNumber": {
            "type": "string",
            "nullable": true
          },
          "originalInvoiceId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "originalInvoiceDate": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "taxRate": {
            "type": "number",
            "nullable": true
          },
          "supplyType": {
            "type": "string",
            "nullable": true
          },
          "scope": {
            "type": "string",
            "enum": [
              "Subscription",
              "Account"
            ]
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true
          },
          "customerGstin": {
            "type": "string",
            "nullable": true
          },
          "lineItems": {
            "type": "array",
            "items": {
              "type": "object",
              "nullable": true
            }
          },
          "wallet": {
            "type": "boolean",
            "nullable": false
          },
          "expiresOn": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "grantPeriodStart": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "grantPeriodEnd": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "transferredFromSubscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "required": [
          "sourceType",
          "accountId",
          "currency",
          "amount",
          "balance",
          "autoPost",
          "excludeFromAutoApplyRules",
          "status",
          "subscriptionId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<CreditMemo, 'id' | 'tenantId'>"
      },
      "DebitMemo": {
        "title": "DebitMemo",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string"
          },
          "invoiceId": {
            "type": "string"
          },
          "sourceType": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "subscriptionId",
          "sourceType",
          "currency",
          "amount",
          "status"
        ],
        "additionalProperties": false
      },
      "NewDebitMemo": {
        "title": "NewDebitMemo",
        "type": "object",
        "description": "(tsType: Omit<DebitMemo, 'id' | 'tenantId'>, schemaOptions: { title: 'NewDebitMemo', exclude: [ 'id', 'tenantId' ] })",
        "properties": {
          "accountId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string"
          },
          "invoiceId": {
            "type": "string"
          },
          "sourceType": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time"
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "accountId",
          "subscriptionId",
          "sourceType",
          "currency",
          "amount",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<DebitMemo, 'id' | 'tenantId'>"
      },
      "InvoiceItem": {
        "title": "InvoiceItem",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "description": {
            "type": "string",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": false
          },
          "unitPrice": {
            "type": "number",
            "nullable": false
          },
          "totalPrice": {
            "type": "number",
            "nullable": false
          },
          "taxAmount": {
            "type": "number",
            "nullable": false
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "taxRate": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "hsnSacCode": {
            "type": "string",
            "nullable": true,
            "maxLength": 8
          },
          "discountAmount": {
            "type": "number",
            "nullable": false
          },
          "itemType": {
            "type": "string",
            "enum": [
              "Rate Plan",
              "Addon",
              "Charge",
              "Price Component",
              "Debit Memo"
            ]
          },
          "entityId": {
            "type": "string",
            "format": "uuid"
          },
          "gstPricing": {
            "type": "string",
            "nullable": true
          },
          "passThrough": {
            "type": "boolean",
            "nullable": true
          },
          "walletCovered": {
            "type": "number",
            "nullable": true
          }
        },
        "required": [
          "description",
          "quantity",
          "unitPrice",
          "totalPrice",
          "taxAmount",
          "discountAmount"
        ],
        "additionalProperties": false
      },
      "CreditMemoApplication": {
        "title": "CreditMemoApplication",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "creditMemoId": {
            "type": "string",
            "format": "uuid"
          },
          "targetId": {
            "type": "string",
            "format": "uuid"
          },
          "targetType": {
            "type": "string"
          },
          "appliedAmount": {
            "type": "number",
            "nullable": false
          },
          "appliedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "createdBy": {
            "type": "string",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "creditMemoId",
          "targetId",
          "targetType",
          "appliedAmount"
        ],
        "additionalProperties": false
      },
      "InvoiceDetails": {
        "title": "InvoiceDetails",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "orderId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "Order",
              "DebitMemo",
              "Manual"
            ]
          },
          "debitMemoId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdByUserId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceDate": {
            "type": "string",
            "format": "date"
          },
          "dueDate": {
            "type": "string",
            "format": "date"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amountWithoutTax": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "invoiceNumber": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "placeOfSupply": {
            "type": "string",
            "nullable": true,
            "maxLength": 64
          },
          "supplyType": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "customerGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "gstPricing": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "discountAmount": {
            "type": "number",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "path": {
            "type": "string",
            "nullable": true
          },
          "lastEmailSentDate": {
            "type": "string",
            "format": "date"
          },
          "postedDate": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Posted",
              "Cancelled",
              "Paid",
              "Partial",
              "Written Off",
              "Overdue"
            ]
          },
          "billingAddress": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "invoiceItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceItem"
            }
          },
          "creditsApplied": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditMemoApplication"
            }
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "sourceType",
          "invoiceDate",
          "currency",
          "balance",
          "status"
        ],
        "additionalProperties": false
      },
      "NewInvoice": {
        "title": "NewInvoice",
        "type": "object",
        "description": "(tsType: Omit<InvoiceDetails, 'invoiceId' | 'tenantId' | 'path' | 'billToContactId' | 'lastEmailSentDate' | 'paymentAmount' | 'refundAmount' | 'createdTs' | 'updatedTs' | 'status' | 'invoiceItemId' | 'chargeDate' | 'transactionId' | 'targetDate'>, schemaOptions: {\n  title: 'NewInvoice',\n  exclude: [\n    'invoiceId',         'tenantId',\n    'path',              'billToContactId',\n    'lastEmailSentDate', 'paymentAmount',\n    'refundAmount',      'createdTs',\n    'updatedTs',         'status',\n    'invoiceItemId',     'chargeDate',\n    'transactionId',     'targetDate'\n  ]\n})",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "orderId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "Order",
              "DebitMemo",
              "Manual"
            ]
          },
          "debitMemoId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdByUserId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceDate": {
            "type": "string",
            "format": "date"
          },
          "dueDate": {
            "type": "string",
            "format": "date"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amountWithoutTax": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "invoiceNumber": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "placeOfSupply": {
            "type": "string",
            "nullable": true,
            "maxLength": 64
          },
          "supplyType": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "customerGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "gstPricing": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "discountAmount": {
            "type": "number",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "postedDate": {
            "type": "string",
            "format": "date"
          },
          "billingAddress": {
            "type": "object",
            "nullable": true
          },
          "invoiceItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceItem"
            }
          },
          "creditsApplied": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreditMemoApplication"
            }
          }
        },
        "required": [
          "accountId",
          "sourceType",
          "invoiceDate",
          "currency",
          "balance"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<InvoiceDetails, 'invoiceId' | 'tenantId' | 'path' | 'billToContactId' | 'lastEmailSentDate' | 'paymentAmount' | 'refundAmount' | 'createdTs' | 'updatedTs' | 'status' | 'invoiceItemId' | 'chargeDate' | 'transactionId' | 'targetDate'>"
      },
      "Invoice": {
        "title": "Invoice",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "orderId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "Order",
              "DebitMemo",
              "Manual"
            ]
          },
          "debitMemoId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdByUserId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceDate": {
            "type": "string",
            "format": "date"
          },
          "dueDate": {
            "type": "string",
            "format": "date"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amountWithoutTax": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "invoiceNumber": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "placeOfSupply": {
            "type": "string",
            "nullable": true,
            "maxLength": 64
          },
          "supplyType": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "customerGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "gstPricing": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "discountAmount": {
            "type": "number",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "path": {
            "type": "string",
            "nullable": true
          },
          "lastEmailSentDate": {
            "type": "string",
            "format": "date"
          },
          "postedDate": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Posted",
              "Cancelled",
              "Paid",
              "Partial",
              "Written Off",
              "Overdue"
            ]
          },
          "billingAddress": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "sourceType",
          "invoiceDate",
          "currency",
          "balance",
          "status"
        ],
        "additionalProperties": false
      },
      "InvoicesWithRelations": {
        "title": "InvoicesWithRelations",
        "type": "object",
        "description": "(tsType: InvoicesWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "invoices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Invoice"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "InvoicesWithRelations"
      },
      "InvoiceWithRelations": {
        "title": "InvoiceWithRelations",
        "type": "object",
        "description": "(tsType: InvoiceWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "orderId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "Order",
              "DebitMemo",
              "Manual"
            ]
          },
          "debitMemoId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "createdByUserId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "invoiceDate": {
            "type": "string",
            "format": "date"
          },
          "dueDate": {
            "type": "string",
            "format": "date"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "amountWithoutTax": {
            "type": "number",
            "nullable": true
          },
          "taxAmount": {
            "type": "number",
            "nullable": true
          },
          "invoiceNumber": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "placeOfSupply": {
            "type": "string",
            "nullable": true,
            "maxLength": 64
          },
          "supplyType": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "supplierGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "customerGstin": {
            "type": "string",
            "nullable": true,
            "maxLength": 15
          },
          "gstPricing": {
            "type": "string",
            "nullable": true,
            "maxLength": 16
          },
          "discountAmount": {
            "type": "number",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "nullable": true
          },
          "balance": {
            "type": "number",
            "nullable": false
          },
          "path": {
            "type": "string",
            "nullable": true
          },
          "lastEmailSentDate": {
            "type": "string",
            "format": "date"
          },
          "postedDate": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Posted",
              "Cancelled",
              "Paid",
              "Partial",
              "Written Off",
              "Overdue"
            ]
          },
          "billingAddress": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "sourceType",
          "invoiceDate",
          "currency",
          "balance",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "InvoiceWithRelations"
      },
      "InvoiceItemWithRelations": {
        "title": "InvoiceItemWithRelations",
        "type": "object",
        "description": "(tsType: InvoiceItemWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "description": {
            "type": "string",
            "nullable": false
          },
          "quantity": {
            "type": "number",
            "nullable": false
          },
          "unitPrice": {
            "type": "number",
            "nullable": false
          },
          "totalPrice": {
            "type": "number",
            "nullable": false
          },
          "taxAmount": {
            "type": "number",
            "nullable": false
          },
          "taxableAmount": {
            "type": "number",
            "nullable": true
          },
          "taxRate": {
            "type": "number",
            "nullable": true
          },
          "cgstAmount": {
            "type": "number",
            "nullable": true
          },
          "sgstAmount": {
            "type": "number",
            "nullable": true
          },
          "igstAmount": {
            "type": "number",
            "nullable": true
          },
          "hsnSacCode": {
            "type": "string",
            "nullable": true,
            "maxLength": 8
          },
          "discountAmount": {
            "type": "number",
            "nullable": false
          },
          "itemType": {
            "type": "string",
            "enum": [
              "Rate Plan",
              "Addon",
              "Charge",
              "Price Component",
              "Debit Memo"
            ]
          },
          "entityId": {
            "type": "string",
            "format": "uuid"
          },
          "gstPricing": {
            "type": "string",
            "nullable": true
          },
          "passThrough": {
            "type": "boolean",
            "nullable": true
          },
          "walletCovered": {
            "type": "number",
            "nullable": true
          }
        },
        "required": [
          "description",
          "quantity",
          "unitPrice",
          "totalPrice",
          "taxAmount",
          "discountAmount"
        ],
        "additionalProperties": false,
        "x-typescript-type": "InvoiceItemWithRelations"
      },
      "Feature": {
        "title": "Feature",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "featureKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "featureType": {
            "type": "string",
            "enum": [
              "Switch",
              "Quantity",
              "Range",
              "Custom"
            ]
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "defaultValue": {
            "type": "string",
            "nullable": true
          },
          "defaultQuantity": {
            "type": "number",
            "nullable": true
          },
          "minValue": {
            "type": "number",
            "nullable": true
          },
          "maxValue": {
            "type": "number",
            "nullable": true
          },
          "customLevels": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "name",
          "featureKey",
          "featureType",
          "isVisibleInPortal",
          "status",
          "productId",
          "tenantId"
        ],
        "additionalProperties": false
      },
      "NewFeature": {
        "title": "NewFeature",
        "type": "object",
        "description": "(tsType: Omit<Feature, 'id' | 'status'>, schemaOptions: { title: 'NewFeature', exclude: [ 'id', 'status' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "featureKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "featureType": {
            "type": "string",
            "enum": [
              "Switch",
              "Quantity",
              "Range",
              "Custom"
            ]
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "defaultValue": {
            "type": "string",
            "nullable": true
          },
          "defaultQuantity": {
            "type": "number",
            "nullable": true
          },
          "minValue": {
            "type": "number",
            "nullable": true
          },
          "maxValue": {
            "type": "number",
            "nullable": true
          },
          "customLevels": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "name",
          "featureKey",
          "featureType",
          "isVisibleInPortal",
          "productId",
          "tenantId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Feature, 'id' | 'status'>"
      },
      "FeaturesWithRelations": {
        "title": "FeaturesWithRelations",
        "type": "object",
        "description": "(tsType: FeaturesWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "features": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "FeaturesWithRelations"
      },
      "FeaturePartialExcluding_id_": {
        "title": "FeaturePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Feature>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "featureKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "featureType": {
            "type": "string",
            "enum": [
              "Switch",
              "Quantity",
              "Range",
              "Custom"
            ]
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "defaultValue": {
            "type": "string",
            "nullable": true
          },
          "defaultQuantity": {
            "type": "number",
            "nullable": true
          },
          "minValue": {
            "type": "number",
            "nullable": true
          },
          "maxValue": {
            "type": "number",
            "nullable": true
          },
          "customLevels": {
            "type": "object",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Feature>, 'id'>"
      },
      "CurrencyMaster": {
        "title": "CurrencyMaster",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "currencyName": {
            "type": "string",
            "nullable": false
          },
          "country": {
            "type": "string",
            "nullable": false
          },
          "symbol": {
            "type": "string",
            "nullable": true
          },
          "isActive": {
            "type": "boolean",
            "nullable": false
          }
        },
        "required": [
          "id",
          "currencyCode",
          "currencyName",
          "country",
          "isActive"
        ],
        "additionalProperties": false
      },
      "CurrencyReq": {
        "title": "CurrencyReq",
        "type": "object",
        "properties": {
          "currencyCode": {
            "type": "string",
            "nullable": false
          }
        },
        "required": [
          "currencyCode"
        ],
        "additionalProperties": false
      },
      "NewCurrency": {
        "title": "NewCurrency",
        "type": "object",
        "description": "(tsType: Omit<CurrencyReq, 'id' | 'tenantId'>, schemaOptions: { title: 'NewCurrency', exclude: [ 'id', 'tenantId' ] })",
        "properties": {
          "currencyCode": {
            "type": "string",
            "nullable": false
          }
        },
        "required": [
          "currencyCode"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<CurrencyReq, 'id' | 'tenantId'>"
      },
      "CouponSet": {
        "title": "CouponSet",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "couponId": {
            "type": "string",
            "format": "uuid"
          },
          "couponCode": {
            "type": "string",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Redeemed",
              "Unredeemed",
              "Archived"
            ]
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "couponId",
          "couponCode",
          "name",
          "tenantId"
        ],
        "additionalProperties": false
      },
      "NewCouponSetBulk": {
        "title": "NewCouponSetBulk",
        "type": "object",
        "description": "(tsType: Omit<CouponSet, 'id' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewCouponSetBulk', exclude: [ 'id', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "couponId": {
            "type": "string",
            "format": "uuid"
          },
          "couponCode": {
            "type": "string",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Redeemed",
              "Unredeemed",
              "Archived"
            ]
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "couponId",
          "couponCode",
          "name",
          "tenantId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<CouponSet, 'id' | 'createdTs' | 'updatedTs'>"
      },
      "CouponSetWithRelations": {
        "title": "CouponSetWithRelations",
        "type": "object",
        "description": "(tsType: CouponSetWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "couponId": {
            "type": "string",
            "format": "uuid"
          },
          "couponCode": {
            "type": "string",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Redeemed",
              "Unredeemed",
              "Archived"
            ]
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "couponId",
          "couponCode",
          "name",
          "tenantId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "CouponSetWithRelations"
      },
      "SMTPTLS": {
        "title": "SMTPTLS",
        "type": "object",
        "properties": {
          "rejectUnauthorized": {
            "type": "boolean"
          }
        },
        "required": [
          "rejectUnauthorized"
        ],
        "additionalProperties": false
      },
      "SMTPAuth": {
        "title": "SMTPAuth",
        "type": "object",
        "properties": {
          "user": {
            "type": "string"
          },
          "pass": {
            "type": "string"
          }
        },
        "required": [
          "user",
          "pass"
        ],
        "additionalProperties": false
      },
      "SmtpServerWithRelations": {
        "title": "SmtpServerWithRelations",
        "type": "object",
        "description": "(tsType: SmtpServerWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "host": {
            "type": "string"
          },
          "port": {
            "type": "number"
          },
          "secure": {
            "type": "boolean"
          },
          "tls": {
            "$ref": "#/components/schemas/SMTPTLS"
          },
          "auth": {
            "$ref": "#/components/schemas/SMTPAuth"
          },
          "user": {
            "type": "string"
          }
        },
        "required": [
          "tenantId",
          "host",
          "port",
          "secure",
          "user"
        ],
        "additionalProperties": false,
        "x-typescript-type": "SmtpServerWithRelations"
      },
      "Charge": {
        "title": "Charge",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "chargeKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          }
        },
        "required": [
          "name",
          "chargeKey",
          "isVisibleInPortal",
          "productId",
          "tenantId",
          "status"
        ],
        "additionalProperties": false
      },
      "NewCharge": {
        "title": "NewCharge",
        "type": "object",
        "description": "(tsType: Omit<Charge, 'chargeId' | 'status' | 'tenantId' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewCharge', exclude: [ 'chargeId', 'status', 'tenantId', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "chargeKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          }
        },
        "required": [
          "name",
          "chargeKey",
          "isVisibleInPortal",
          "productId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Charge, 'chargeId' | 'status' | 'tenantId' | 'createdTs' | 'updatedTs'>"
      },
      "ChargesWithRelations": {
        "title": "ChargesWithRelations",
        "type": "object",
        "description": "(tsType: ChargesWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "charges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Charge"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "ChargesWithRelations"
      },
      "ChargePartialExcluding_id_": {
        "title": "ChargePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Charge>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "chargeKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Charge>, 'id'>"
      },
      "ChargePrice": {
        "title": "ChargePrice",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "chargeId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "chargePriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Flat Fee Pricing"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "required": [
          "name",
          "currencyCode",
          "status",
          "chargeId",
          "chargePriceKey",
          "pricingModel",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false
      },
      "NewChargePrice": {
        "title": "NewChargePrice",
        "type": "object",
        "description": "(tsType: Omit<ChargePrice, 'chargeId' | 'status' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewChargePrice', exclude: [ 'chargeId', 'status', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "chargePriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Flat Fee Pricing"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "required": [
          "name",
          "currencyCode",
          "chargePriceKey",
          "pricingModel",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<ChargePrice, 'chargeId' | 'status' | 'createdTs' | 'updatedTs'>"
      },
      "ChargePriceView": {
        "title": "ChargePriceView",
        "type": "object",
        "properties": {
          "chargePriceId": {
            "type": "string",
            "nullable": true
          },
          "chargePriceName": {
            "type": "string",
            "nullable": true
          },
          "customerDescription": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "chargePriceKey": {
            "type": "string",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": true
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "pricingModel": {
            "type": "string",
            "nullable": true
          },
          "chargeId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "chargeKey": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          },
          "productId": {
            "type": "string",
            "nullable": true
          },
          "tenantId": {
            "type": "string",
            "nullable": true
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "ChargePrices": {
        "title": "ChargePrices",
        "type": "object",
        "properties": {
          "chargePrices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChargePriceView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "ChargePricePartialExcluding_id_": {
        "title": "ChargePricePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<ChargePrice>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "chargeId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "chargePriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Flat Fee Pricing"
            ]
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<ChargePrice>, 'id'>"
      },
      "NewBillingStrategy": {
        "title": "NewBillingStrategy",
        "type": "object",
        "description": "(tsType: Omit<Period, 'id' | 'tenantId' | 'isOpted' | 'isTrial'>, schemaOptions: { title: 'NewBillingStrategy', exclude: [ 'id', 'tenantId', 'isOpted', 'isTrial' ] })",
        "properties": {
          "periodName": {
            "type": "string",
            "nullable": false
          },
          "term": {
            "type": "number",
            "nullable": false
          },
          "period": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Day",
              "Week",
              "Month",
              "Year"
            ]
          },
          "termLength": {
            "type": "integer",
            "nullable": false,
            "minimum": 1
          }
        },
        "required": [
          "periodName",
          "term",
          "period"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Period, 'id' | 'tenantId' | 'isOpted' | 'isTrial'>"
      },
      "Credentials": {
        "title": "Credentials",
        "type": "object",
        "description": "(tsType: Credential, schemaOptions: { title: 'Credentials' })",
        "properties": {
          "email": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        },
        "required": [
          "email",
          "password"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Credential"
      },
      "Credential": {
        "title": "Credential",
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        },
        "required": [
          "email",
          "password"
        ],
        "additionalProperties": false
      },
      "ForgetPassword": {
        "title": "ForgetPassword",
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          }
        },
        "required": [
          "email"
        ],
        "additionalProperties": false
      },
      "ApiKey": {
        "title": "ApiKey",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "key": {
            "type": "string",
            "nullable": false
          },
          "isActive": {
            "type": "boolean",
            "nullable": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "keyType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Full-Access Key",
              "Read-Only Key",
              "Publishable Key"
            ]
          },
          "apiKeySubType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "All",
              "Update Key",
              "Write Key",
              "Restricted"
            ]
          },
          "accessLevel": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "items": {
                "type": "string",
                "enum": [
                  "read_transactional_data",
                  "estimate_api",
                  "read_product_catalog"
                ]
              }
            }
          },
          "permissionIds": {
            "type": "object",
            "nullable": false
          }
        },
        "required": [
          "tenantId",
          "key",
          "isActive",
          "createdAt",
          "name",
          "keyType"
        ],
        "additionalProperties": false
      },
      "ApiKeysWithRelations": {
        "title": "ApiKeysWithRelations",
        "type": "object",
        "description": "(tsType: ApiKeysWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "apiKeys": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiKey"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "ApiKeysWithRelations"
      },
      "Permission": {
        "title": "Permission",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true
            }
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      },
      "PermissionsWithRelations": {
        "title": "PermissionsWithRelations",
        "type": "object",
        "description": "(tsType: PermissionsWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "permissions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Permission"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "PermissionsWithRelations"
      },
      "ApiKeyWithRelations": {
        "title": "ApiKeyWithRelations",
        "type": "object",
        "description": "(tsType: ApiKeyWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "key": {
            "type": "string",
            "nullable": false
          },
          "isActive": {
            "type": "boolean",
            "nullable": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "keyType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Full-Access Key",
              "Read-Only Key",
              "Publishable Key"
            ]
          },
          "apiKeySubType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "All",
              "Update Key",
              "Write Key",
              "Restricted"
            ]
          },
          "accessLevel": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "items": {
                "type": "string",
                "enum": [
                  "read_transactional_data",
                  "estimate_api",
                  "read_product_catalog"
                ]
              }
            }
          },
          "permissionIds": {
            "type": "object",
            "nullable": false
          }
        },
        "required": [
          "tenantId",
          "key",
          "isActive",
          "createdAt",
          "name",
          "keyType"
        ],
        "additionalProperties": false,
        "x-typescript-type": "ApiKeyWithRelations"
      },
      "NewApiKey": {
        "title": "NewApiKey",
        "type": "object",
        "description": "(tsType: Omit<ApiKey, 'id' | 'createdAt' | 'key' | 'isActive' | 'permissionIds' | 'tenantId'>, schemaOptions: { title: 'NewApiKey', exclude: [ 'id', 'createdAt', 'key', 'isActive', 'permissionIds', 'tenantId' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "keyType": {
            "type": "string",
            "nullable": false,
            "enum": [
              "Full-Access Key",
              "Read-Only Key",
              "Publishable Key"
            ]
          },
          "apiKeySubType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "All",
              "Update Key",
              "Write Key",
              "Restricted"
            ]
          },
          "accessLevel": {
            "type": "array",
            "items": {
              "type": "string",
              "nullable": true,
              "items": {
                "type": "string",
                "enum": [
                  "read_transactional_data",
                  "estimate_api",
                  "read_product_catalog"
                ]
              }
            }
          }
        },
        "required": [
          "name",
          "keyType"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<ApiKey, 'id' | 'createdAt' | 'key' | 'isActive' | 'permissionIds' | 'tenantId'>"
      },
      "SubscriptionStatusBreakdown": {
        "title": "SubscriptionStatusBreakdown",
        "type": "object",
        "description": "(tsType: SubscriptionStatusBreakdown, schemaOptions: { title: 'SubscriptionStatusBreakdown' })",
        "properties": {
          "summary": {
            "type": "object"
          },
          "statusBreakdown": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "monthlyTrend": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "statusByPlan": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "required": [
          "summary",
          "statusBreakdown",
          "monthlyTrend",
          "statusByPlan"
        ],
        "additionalProperties": false,
        "x-typescript-type": "SubscriptionStatusBreakdown"
      },
      "NewVsCancelledSubscriptions": {
        "title": "NewVsCancelledSubscriptions",
        "type": "object",
        "description": "(tsType: NewVsCancelledSubscriptions, schemaOptions: { title: 'NewVsCancelledSubscriptions' })",
        "properties": {
          "tenantId": {
            "type": "string"
          },
          "overallMetrics": {
            "type": "object"
          },
          "monthlyBreakdown": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "planBreakdown": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "cancellationReasons": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "alerts": {
            "type": "object"
          }
        },
        "required": [
          "tenantId",
          "overallMetrics",
          "monthlyBreakdown",
          "planBreakdown",
          "cancellationReasons",
          "alerts"
        ],
        "additionalProperties": false,
        "x-typescript-type": "NewVsCancelledSubscriptions"
      },
      "SubscriptionRenewalRate": {
        "title": "SubscriptionRenewalRate",
        "type": "object",
        "description": "(tsType: SubscriptionRenewalRate, schemaOptions: { title: 'SubscriptionRenewalRate' })",
        "properties": {
          "tenant_id": {
            "type": "string"
          },
          "overall_metrics": {
            "type": "object"
          },
          "monthly_data": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "plan_data": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "failure_reasons": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "SubscriptionRenewalRate"
      },
      "PaymentSuccessRate": {
        "title": "PaymentSuccessRate",
        "type": "object",
        "description": "(tsType: PaymentSuccessRate, schemaOptions: { title: 'PaymentSuccessRate' })",
        "properties": {
          "tenant_id": {
            "type": "string"
          },
          "overall_metrics": {
            "type": "object"
          },
          "monthly_data": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "failure_reasons": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "payment_methods": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "PaymentSuccessRate"
      },
      "AnnualRecurringRevenue": {
        "title": "AnnualRecurringRevenue",
        "type": "object",
        "description": "(tsType: AnnualRecurringRevenue, schemaOptions: { title: 'AnnualRecurringRevenue' })",
        "properties": {
          "tenant_id": {
            "type": "string"
          },
          "summary": {
            "type": "object"
          },
          "monthly_data": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "AnnualRecurringRevenue"
      },
      "NewAddon": {
        "title": "NewAddon",
        "type": "object",
        "description": "(tsType: Omit<Addon, 'addonId' | 'status'>, schemaOptions: { title: 'NewAddon', exclude: [ 'addonId', 'status' ] })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "addonKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "name",
          "addonKey",
          "isVisibleInPortal",
          "productId",
          "tenantId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Addon, 'addonId' | 'status'>"
      },
      "AddonsWithRelations": {
        "title": "AddonsWithRelations",
        "type": "object",
        "description": "(tsType: AddonsWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "addons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Addon"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "AddonsWithRelations"
      },
      "AddonPartialExcluding_id_": {
        "title": "AddonPartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Addon>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "addonKey": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": false
          },
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Addon>, 'id'>"
      },
      "AddonPrice": {
        "title": "AddonPrice",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "billingPeriodId": {
            "type": "string",
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "addonId": {
            "type": "string",
            "format": "uuid"
          },
          "billingPeriodName": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "addonPriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "enum": [
              "Flat Fee Pricing",
              "Per Unit Pricing",
              "Volume Pricing"
            ]
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "currencyCode",
          "status",
          "billingPeriodId",
          "addonId",
          "billingPeriodName",
          "addonPriceKey",
          "pricingModel",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false
      },
      "NewAddonPrice": {
        "title": "NewAddonPrice",
        "type": "object",
        "description": "(tsType: Omit<AddonPrice, 'addonId' | 'status' | 'createdTs' | 'updatedTs'>, schemaOptions: { title: 'NewAddonPrice', exclude: [ 'addonId', 'status', 'createdTs', 'updatedTs' ] })",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "billingPeriodId": {
            "type": "string",
            "format": "uuid"
          },
          "billingPeriodName": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "addonPriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "enum": [
              "Flat Fee Pricing",
              "Per Unit Pricing",
              "Volume Pricing"
            ]
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "currencyCode",
          "billingPeriodId",
          "billingPeriodName",
          "addonPriceKey",
          "pricingModel",
          "showDescInInvoice",
          "showDescInQuote"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<AddonPrice, 'addonId' | 'status' | 'createdTs' | 'updatedTs'>"
      },
      "AddonPriceView": {
        "title": "AddonPriceView",
        "type": "object",
        "properties": {
          "addonId": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "addonKey": {
            "type": "string",
            "nullable": true
          },
          "unitOfMeasurement": {
            "type": "string",
            "nullable": true
          },
          "isVisibleInPortal": {
            "type": "boolean",
            "nullable": true
          },
          "productId": {
            "type": "string",
            "nullable": true
          },
          "productName": {
            "type": "string",
            "nullable": true
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "addonPriceId": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "customerDescription": {
            "type": "string",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "billingPeriodId": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "billingPeriod": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "addonPriceKey": {
            "type": "string",
            "nullable": true
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": true
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": true
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "pricingModel": {
            "type": "string",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": true
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AddonPrices": {
        "title": "AddonPrices",
        "type": "object",
        "properties": {
          "addonPrices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AddonPriceView"
            }
          },
          "count": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "AddonPricePartialExcluding_id_": {
        "title": "AddonPricePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<AddonPrice>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "name": {
            "type": "string",
            "nullable": false
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": false
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "Active",
              "Inactive"
            ]
          },
          "billingPeriodId": {
            "type": "string",
            "format": "uuid"
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "addonId": {
            "type": "string",
            "format": "uuid"
          },
          "billingPeriodName": {
            "type": "string",
            "nullable": false
          },
          "externalName": {
            "type": "string",
            "nullable": true
          },
          "addonPriceKey": {
            "type": "string",
            "nullable": false
          },
          "pricingModel": {
            "type": "string",
            "enum": [
              "Flat Fee Pricing",
              "Per Unit Pricing",
              "Volume Pricing"
            ]
          },
          "overage": {
            "type": "number",
            "nullable": true
          },
          "showDescInInvoice": {
            "type": "boolean",
            "nullable": false
          },
          "showDescInQuote": {
            "type": "boolean",
            "nullable": false
          },
          "invoiceNote": {
            "type": "string",
            "nullable": true
          },
          "eventType": {
            "type": "string",
            "nullable": true
          },
          "aggregation": {
            "type": "string",
            "nullable": true,
            "enum": [
              "SUM",
              "COUNT",
              "MIN",
              "MAX",
              "AVG",
              null
            ]
          },
          "aggProperty": {
            "type": "string",
            "nullable": true
          },
          "filters": {
            "type": "object",
            "nullable": true
          },
          "taxIncluded": {
            "type": "boolean",
            "nullable": false
          },
          "taxProfileId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "passThroughTaxable": {
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<AddonPrice>, 'id'>"
      },
      "AddonFeature": {
        "title": "AddonFeature",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "addonId",
          "featureId"
        ],
        "additionalProperties": false
      },
      "NewAddonFeature": {
        "title": "NewAddonFeature",
        "type": "object",
        "description": "(tsType: Omit<AddonFeature, 'id'>, schemaOptions: { title: 'NewAddonFeature', exclude: [ 'id' ] })",
        "properties": {
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "addonId",
          "featureId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<AddonFeature, 'id'>"
      },
      "AddonFeatureWithRelations": {
        "title": "AddonFeatureWithRelations",
        "type": "object",
        "description": "(tsType: AddonFeatureWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "required": [
          "addonId",
          "featureId"
        ],
        "additionalProperties": false,
        "x-typescript-type": "AddonFeatureWithRelations"
      },
      "AddonFeaturePartialExcluding_id_": {
        "title": "AddonFeaturePartialExcluding_id_",
        "type": "object",
        "description": "(tsType: Omit<Partial<AddonFeature>, 'id'>, schemaOptions: { partial: true, exclude: [ 'id' ] })",
        "properties": {
          "addonId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "featureId": {
            "type": "string",
            "nullable": false,
            "format": "uuid"
          },
          "switchValue": {
            "type": "boolean",
            "nullable": true
          },
          "quantityValue": {
            "type": "number",
            "nullable": true
          },
          "rangeMin": {
            "type": "number",
            "nullable": true
          },
          "rangeMax": {
            "type": "number",
            "nullable": true
          },
          "customValue": {
            "type": "string",
            "nullable": true
          },
          "createdTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          },
          "updatedTs": {
            "type": "string",
            "format": "date-time",
            "nullable": false
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<AddonFeature>, 'id'>"
      },
      "NewAccountInfo": {
        "title": "NewAccountInfo",
        "type": "object",
        "description": "(tsType: Omit<AccountInfo, 'accountId' | 'tenantId'>, schemaOptions: { title: 'NewAccountInfo', exclude: [ 'accountId', 'tenantId' ] })",
        "properties": {
          "name": {
            "type": "string",
            "description": "Optional <br>Name of the account. It will be organization name if accountType is \"Organisation\" and concatenation of first name and last name if accountType is \"Individual\""
          },
          "address": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "zipCode": {
            "type": "string"
          },
          "gstin": {
            "type": "string",
            "description": "Customer GSTIN (15 characters); its first two digits are the state code.",
            "nullable": true,
            "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z]Z[0-9A-Z]$",
            "maxLength": 15
          },
          "stateCode": {
            "type": "string",
            "description": "GST state code of the bill-to state (derived from the GSTIN when blank).",
            "nullable": true,
            "pattern": "^[0-9]{2}$"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "description": "root email id of the user."
          },
          "accountType": {
            "type": "string",
            "description": "Represents the type of customer.",
            "enum": [
              "Organisation",
              "Individual"
            ]
          },
          "parentAccountId": {
            "type": "string",
            "description": "Optional <br>In an account hierarchy, the parent account ID refers to the unique identifier of the account that is considered the parent or superior account in the hierarchy. It represents the relationship between different accounts within a hierarchical structure.",
            "format": "uuid"
          },
          "communicationProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "sameAsSoldTo": {
            "type": "boolean",
            "description": "Set to true if billing contact is same as sold to contact otherwise false."
          },
          "billingProfile": {
            "$ref": "#/components/schemas/AccountContact"
          },
          "autoPay": {
            "type": "boolean",
            "description": "Optional <br>Auto Pay refers to the automatic collection of payment for a subscription or service.<br>Default value: false"
          },
          "currency": {
            "type": "string",
            "description": "Preferred currency customer would like to deal in. <br>Not mandatory to create a customer but it should be updated before subscription to any service.",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "balance": {
            "type": "number",
            "description": "Balance of the account"
          },
          "mrr": {
            "type": "number"
          },
          "netTermDays": {
            "type": "number",
            "description": "Optional <br>Net term days, also known as payment terms or credit terms, refer to the number of days a buyer has to pay an invoice or outstanding balance to a seller or vendor. It specifies the timeframe within which payment is expected to be made after the delivery of goods or completion of services."
          },
          "createdOn": {
            "type": "string",
            "description": "Timestamp when customer is created. No need to mention as system automatically capture this.",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "description": "Represents current status of customer.",
            "enum": [
              "Draft",
              "In Trial",
              "Active",
              "Inactive",
              "Dormant"
            ]
          }
        },
        "required": [
          "phone",
          "email"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<AccountInfo, 'accountId' | 'tenantId'>"
      },
      "AccountPartialExcluding_accountId_": {
        "title": "AccountPartialExcluding_accountId_",
        "type": "object",
        "description": "(tsType: Omit<Partial<Account>, 'accountId'>, schemaOptions: { partial: true, exclude: [ 'accountId' ] })",
        "properties": {
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "zipCode": {
            "type": "string"
          },
          "gstin": {
            "type": "string",
            "description": "Customer GSTIN (15 characters); its first two digits are the state code.",
            "nullable": true,
            "pattern": "^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z]Z[0-9A-Z]$",
            "maxLength": 15
          },
          "stateCode": {
            "type": "string",
            "description": "GST state code of the bill-to state (derived from the GSTIN when blank).",
            "nullable": true,
            "pattern": "^[0-9]{2}$"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "accountType": {
            "type": "string",
            "enum": [
              "Organisation",
              "Individual"
            ]
          },
          "parentAccountId": {
            "type": "string",
            "format": "uuid"
          },
          "sameAsSoldTo": {
            "type": "boolean"
          },
          "soldToId": {
            "type": "string",
            "format": "uuid"
          },
          "billToId": {
            "type": "string",
            "format": "uuid"
          },
          "autoPay": {
            "type": "boolean"
          },
          "currency": {
            "type": "string",
            "enum": [
              "INR",
              "USD",
              "CAD",
              "GBP",
              "AUD"
            ]
          },
          "balance": {
            "type": "number"
          },
          "mrr": {
            "type": "number"
          },
          "netTermDays": {
            "type": "number"
          },
          "createdOn": {
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "enum": [
              "Draft",
              "In Trial",
              "Active",
              "Inactive",
              "Dormant"
            ]
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Partial<Account>, 'accountId'>"
      },
      "CardDisplay": {
        "title": "CardDisplay",
        "type": "object",
        "properties": {
          "last4": {
            "type": "string",
            "pattern": "^[0-9]{4}$"
          },
          "network": {
            "type": "string"
          },
          "bank": {
            "type": "string"
          },
          "cardType": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "PaymentMethodWithRelations": {
        "title": "PaymentMethodWithRelations",
        "type": "object",
        "description": "(tsType: PaymentMethodWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "paymentMethodId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "paymentMethodType": {
            "type": "string"
          },
          "extCustomerProfileId": {
            "type": "string"
          },
          "extPaymentMethodId": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "isAuthorised": {
            "type": "boolean"
          },
          "card": {
            "type": "string"
          },
          "ach": {
            "type": "string"
          },
          "directDebit": {
            "type": "string"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/CardDisplay"
          }
        },
        "required": [
          "accountId",
          "paymentMethodType"
        ],
        "additionalProperties": false,
        "x-typescript-type": "PaymentMethodWithRelations"
      },
      "PaymentMethodPartial": {
        "title": "PaymentMethodPartial",
        "type": "object",
        "description": "(tsType: Partial<PaymentMethod>, schemaOptions: { partial: true })",
        "properties": {
          "paymentMethodId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "paymentMethodType": {
            "type": "string"
          },
          "extCustomerProfileId": {
            "type": "string"
          },
          "extPaymentMethodId": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "isAuthorised": {
            "type": "boolean"
          },
          "card": {
            "type": "string"
          },
          "ach": {
            "type": "string"
          },
          "directDebit": {
            "type": "string"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/CardDisplay"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<PaymentMethod>"
      },
      "PaymentMethod": {
        "title": "PaymentMethod",
        "type": "object",
        "properties": {
          "paymentMethodId": {
            "type": "string",
            "format": "uuid"
          },
          "accountId": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "paymentMethodType": {
            "type": "string"
          },
          "extCustomerProfileId": {
            "type": "string"
          },
          "extPaymentMethodId": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "isAuthorised": {
            "type": "boolean"
          },
          "card": {
            "type": "string"
          },
          "ach": {
            "type": "string"
          },
          "directDebit": {
            "type": "string"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/CardDisplay"
          }
        },
        "required": [
          "accountId",
          "paymentMethodType"
        ],
        "additionalProperties": false
      },
      "PaymentAuth": {
        "title": "PaymentAuth",
        "type": "object",
        "properties": {
          "paymentMethodType": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cardNumber": {
            "type": "string"
          },
          "expirationDate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}$"
          },
          "cardCode": {
            "type": "string"
          },
          "isAuthorised": {
            "type": "boolean"
          },
          "isDefault": {
            "type": "boolean"
          }
        },
        "required": [
          "paymentMethodType",
          "name",
          "isAuthorised",
          "isDefault"
        ],
        "additionalProperties": true
      },
      "AuthorizePayment": {
        "title": "AuthorizePayment",
        "type": "object",
        "description": "(tsType: PaymentAuth, schemaOptions: { title: 'AuthorizePayment' })",
        "properties": {
          "paymentMethodType": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cardNumber": {
            "type": "string"
          },
          "expirationDate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}$"
          },
          "cardCode": {
            "type": "string"
          },
          "isAuthorised": {
            "type": "boolean"
          },
          "isDefault": {
            "type": "boolean"
          }
        },
        "required": [
          "paymentMethodType",
          "name",
          "isAuthorised",
          "isDefault"
        ],
        "additionalProperties": true,
        "x-typescript-type": "PaymentAuth"
      },
      "Contact": {
        "title": "Contact",
        "type": "object",
        "properties": {
          "contactId": {
            "type": "string",
            "format": "uuid"
          },
          "fullName": {
            "type": "string"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive"
            ]
          },
          "billNotification": {
            "type": "boolean"
          },
          "accountNotification": {
            "type": "boolean"
          }
        },
        "required": [
          "fullName",
          "accountId",
          "phone",
          "email",
          "tenantId",
          "status"
        ],
        "additionalProperties": false
      },
      "NewContact": {
        "title": "NewContact",
        "type": "object",
        "description": "(tsType: Omit<Contact, 'contactId' | 'accountId' | 'status' | 'tenantId'>, schemaOptions: { title: 'NewContact', exclude: [ 'contactId', 'accountId', 'status', 'tenantId' ] })",
        "properties": {
          "fullName": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "billNotification": {
            "type": "boolean"
          },
          "accountNotification": {
            "type": "boolean"
          }
        },
        "required": [
          "fullName",
          "phone",
          "email"
        ],
        "additionalProperties": false,
        "x-typescript-type": "Omit<Contact, 'contactId' | 'accountId' | 'status' | 'tenantId'>"
      },
      "ContactPartial": {
        "title": "ContactPartial",
        "type": "object",
        "description": "(tsType: Partial<Contact>, schemaOptions: { partial: true })",
        "properties": {
          "contactId": {
            "type": "string",
            "format": "uuid"
          },
          "fullName": {
            "type": "string"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive"
            ]
          },
          "billNotification": {
            "type": "boolean"
          },
          "accountNotification": {
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Partial<Contact>"
      },
      "ContactWithRelations": {
        "title": "ContactWithRelations",
        "type": "object",
        "description": "(tsType: ContactWithRelations, schemaOptions: { includeRelations: true })",
        "properties": {
          "contactId": {
            "type": "string",
            "format": "uuid"
          },
          "fullName": {
            "type": "string"
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "tenantId": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive"
            ]
          },
          "billNotification": {
            "type": "boolean"
          },
          "accountNotification": {
            "type": "boolean"
          }
        },
        "required": [
          "fullName",
          "accountId",
          "phone",
          "email",
          "tenantId",
          "status"
        ],
        "additionalProperties": false,
        "x-typescript-type": "ContactWithRelations"
      },
      "ActivityLog": {
        "title": "ActivityLog",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "timeStamp": {
            "type": "string",
            "format": "date-time"
          },
          "event": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "entityId": {
            "type": "string",
            "format": "uuid"
          },
          "eventType": {
            "type": "string"
          },
          "severity": {
            "type": "string"
          },
          "correlationId": {
            "type": "string",
            "format": "uuid"
          },
          "actorId": {
            "type": "string"
          },
          "actorName": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "metadata": {
            "type": "object"
          },
          "relatedEntities": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "tenantId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "event",
          "category"
        ],
        "additionalProperties": false
      },
      "Date": {},
      "NewBillingAddress": {
        "title": "NewBillingAddress",
        "type": "object",
        "description": "(tsType: Omit<Address, 'contactId' | 'tenantId'>, schemaOptions: { title: 'NewBillingAddress', exclude: [ 'contactId', 'tenantId' ] })",
        "properties": {
          "fullName": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "isPrimary": {
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "Omit<Address, 'contactId' | 'tenantId'>"
      },
      "Address": {
        "title": "Address",
        "type": "object",
        "properties": {
          "contactId": {
            "type": "string",
            "format": "uuid"
          },
          "fullName": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "isPrimary": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "loopback.Count": {
        "type": "object",
        "title": "loopback.Count",
        "x-typescript-type": "@loopback/repository#Count",
        "properties": {
          "count": {
            "type": "number"
          }
        }
      },
      "ActivityLog.Filter": {
        "type": "object",
        "title": "ActivityLog.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "ActivityLog.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "timeStamp": {
                    "type": "boolean"
                  },
                  "event": {
                    "type": "boolean"
                  },
                  "category": {
                    "type": "boolean"
                  },
                  "entityId": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "severity": {
                    "type": "boolean"
                  },
                  "correlationId": {
                    "type": "boolean"
                  },
                  "actorId": {
                    "type": "boolean"
                  },
                  "actorName": {
                    "type": "boolean"
                  },
                  "ipAddress": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "boolean"
                  },
                  "metadata": {
                    "type": "boolean"
                  },
                  "relatedEntities": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "timeStamp",
                    "event",
                    "category",
                    "entityId",
                    "eventType",
                    "severity",
                    "correlationId",
                    "actorId",
                    "actorName",
                    "ipAddress",
                    "reason",
                    "metadata",
                    "relatedEntities",
                    "accountId",
                    "tenantId",
                    "subscriptionId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "ActivityLog.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<ActivityLog>"
      },
      "Address.Filter": {
        "type": "object",
        "title": "Address.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "contactId": {
                    "type": "boolean"
                  },
                  "fullName": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "boolean"
                  },
                  "country": {
                    "type": "boolean"
                  },
                  "phone": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "boolean"
                  },
                  "isPrimary": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "contactId",
                    "fullName",
                    "address",
                    "country",
                    "phone",
                    "email",
                    "isPrimary"
                  ],
                  "example": "contactId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Address.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Address>"
      },
      "Contact.Filter": {
        "type": "object",
        "title": "Contact.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Contact.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "contactId": {
                    "type": "boolean"
                  },
                  "fullName": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "boolean"
                  },
                  "country": {
                    "type": "boolean"
                  },
                  "phone": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "billNotification": {
                    "type": "boolean"
                  },
                  "accountNotification": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "contactId",
                    "fullName",
                    "accountId",
                    "address",
                    "country",
                    "phone",
                    "email",
                    "tenantId",
                    "status",
                    "billNotification",
                    "accountNotification"
                  ],
                  "example": "contactId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Contact.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Contact>"
      },
      "PaymentMethod.Filter": {
        "type": "object",
        "title": "PaymentMethod.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "PaymentMethod.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "paymentMethodId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "paymentMethodType": {
                    "type": "boolean"
                  },
                  "extCustomerProfileId": {
                    "type": "boolean"
                  },
                  "extPaymentMethodId": {
                    "type": "boolean"
                  },
                  "isDefault": {
                    "type": "boolean"
                  },
                  "isAuthorised": {
                    "type": "boolean"
                  },
                  "card": {
                    "type": "boolean"
                  },
                  "ach": {
                    "type": "boolean"
                  },
                  "directDebit": {
                    "type": "boolean"
                  },
                  "paymentMethod": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "paymentMethodId",
                    "accountId",
                    "tenantId",
                    "paymentMethodType",
                    "extCustomerProfileId",
                    "extPaymentMethodId",
                    "isDefault",
                    "isAuthorised",
                    "card",
                    "ach",
                    "directDebit",
                    "paymentMethod"
                  ],
                  "example": "paymentMethodId"
                },
                "uniqueItems": true
              }
            ],
            "title": "PaymentMethod.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<PaymentMethod>"
      },
      "Account.Filter": {
        "type": "object",
        "title": "Account.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "boolean"
                  },
                  "state": {
                    "type": "boolean"
                  },
                  "city": {
                    "type": "boolean"
                  },
                  "zipCode": {
                    "type": "boolean"
                  },
                  "gstin": {
                    "type": "boolean"
                  },
                  "stateCode": {
                    "type": "boolean"
                  },
                  "country": {
                    "type": "boolean"
                  },
                  "phone": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "boolean"
                  },
                  "accountType": {
                    "type": "boolean"
                  },
                  "parentAccountId": {
                    "type": "boolean"
                  },
                  "sameAsSoldTo": {
                    "type": "boolean"
                  },
                  "soldToId": {
                    "type": "boolean"
                  },
                  "billToId": {
                    "type": "boolean"
                  },
                  "autoPay": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "balance": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "netTermDays": {
                    "type": "boolean"
                  },
                  "createdOn": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "accountId",
                    "name",
                    "address",
                    "state",
                    "city",
                    "zipCode",
                    "gstin",
                    "stateCode",
                    "country",
                    "phone",
                    "email",
                    "accountType",
                    "parentAccountId",
                    "sameAsSoldTo",
                    "soldToId",
                    "billToId",
                    "autoPay",
                    "currency",
                    "balance",
                    "mrr",
                    "netTermDays",
                    "createdOn",
                    "status"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Account.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Account>"
      },
      "Account.Filter1": {
        "type": "object",
        "title": "Account.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Account.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "address": {
                    "type": "boolean"
                  },
                  "state": {
                    "type": "boolean"
                  },
                  "city": {
                    "type": "boolean"
                  },
                  "zipCode": {
                    "type": "boolean"
                  },
                  "gstin": {
                    "type": "boolean"
                  },
                  "stateCode": {
                    "type": "boolean"
                  },
                  "country": {
                    "type": "boolean"
                  },
                  "phone": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "boolean"
                  },
                  "accountType": {
                    "type": "boolean"
                  },
                  "parentAccountId": {
                    "type": "boolean"
                  },
                  "sameAsSoldTo": {
                    "type": "boolean"
                  },
                  "soldToId": {
                    "type": "boolean"
                  },
                  "billToId": {
                    "type": "boolean"
                  },
                  "autoPay": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "balance": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "netTermDays": {
                    "type": "boolean"
                  },
                  "createdOn": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "accountId",
                    "name",
                    "address",
                    "state",
                    "city",
                    "zipCode",
                    "gstin",
                    "stateCode",
                    "country",
                    "phone",
                    "email",
                    "accountType",
                    "parentAccountId",
                    "sameAsSoldTo",
                    "soldToId",
                    "billToId",
                    "autoPay",
                    "currency",
                    "balance",
                    "mrr",
                    "netTermDays",
                    "createdOn",
                    "status"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Account.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Account>"
      },
      "AddonFeature.Filter": {
        "type": "object",
        "title": "AddonFeature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "addonId": {
                    "type": "boolean"
                  },
                  "featureId": {
                    "type": "boolean"
                  },
                  "switchValue": {
                    "type": "boolean"
                  },
                  "quantityValue": {
                    "type": "boolean"
                  },
                  "rangeMin": {
                    "type": "boolean"
                  },
                  "rangeMax": {
                    "type": "boolean"
                  },
                  "customValue": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "addonId",
                    "featureId",
                    "switchValue",
                    "quantityValue",
                    "rangeMin",
                    "rangeMax",
                    "customValue",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "AddonFeature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<AddonFeature>"
      },
      "AddonFeature.Filter1": {
        "type": "object",
        "title": "AddonFeature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "AddonFeature.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "addonId": {
                    "type": "boolean"
                  },
                  "featureId": {
                    "type": "boolean"
                  },
                  "switchValue": {
                    "type": "boolean"
                  },
                  "quantityValue": {
                    "type": "boolean"
                  },
                  "rangeMin": {
                    "type": "boolean"
                  },
                  "rangeMax": {
                    "type": "boolean"
                  },
                  "customValue": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "addonId",
                    "featureId",
                    "switchValue",
                    "quantityValue",
                    "rangeMin",
                    "rangeMax",
                    "customValue",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "AddonFeature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<AddonFeature>"
      },
      "Addon.Filter": {
        "type": "object",
        "title": "Addon.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "addonKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "status",
                    "createdTs",
                    "updatedTs",
                    "addonKey",
                    "externalName",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Addon.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Addon>"
      },
      "AddonPriceView.Filter": {
        "type": "object",
        "title": "AddonPriceView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "AddonPriceView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "addonId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "addonKey": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "productName": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "addonPriceId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "customerDescription": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "addonPriceKey": {
                    "type": "boolean"
                  },
                  "overage": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  },
                  "passThroughTaxable": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "addonId",
                    "name",
                    "description",
                    "addonKey",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "productId",
                    "productName",
                    "externalName",
                    "addonPriceId",
                    "status",
                    "customerDescription",
                    "currencyCode",
                    "billingPeriodId",
                    "price",
                    "billingPeriod",
                    "quantity",
                    "addonPriceKey",
                    "overage",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "pricingModel",
                    "taxIncluded",
                    "taxProfileId",
                    "passThroughTaxable"
                  ],
                  "example": "addonId"
                },
                "uniqueItems": true
              }
            ],
            "title": "AddonPriceView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<AddonPriceView>"
      },
      "AddonPrice.Filter": {
        "type": "object",
        "title": "AddonPrice.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "addonId": {
                    "type": "boolean"
                  },
                  "billingPeriodName": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "addonPriceKey": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "overage": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "aggregation": {
                    "type": "boolean"
                  },
                  "aggProperty": {
                    "type": "boolean"
                  },
                  "filters": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  },
                  "passThroughTaxable": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "price",
                    "quantity",
                    "currencyCode",
                    "status",
                    "billingPeriodId",
                    "createdTs",
                    "updatedTs",
                    "addonId",
                    "billingPeriodName",
                    "externalName",
                    "addonPriceKey",
                    "pricingModel",
                    "overage",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "eventType",
                    "aggregation",
                    "aggProperty",
                    "filters",
                    "taxIncluded",
                    "taxProfileId",
                    "passThroughTaxable"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "AddonPrice.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<AddonPrice>"
      },
      "Addon.Filter1": {
        "type": "object",
        "title": "Addon.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Addon.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "addonKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "status",
                    "createdTs",
                    "updatedTs",
                    "addonKey",
                    "externalName",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Addon.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Addon>"
      },
      "Permission.Filter": {
        "type": "object",
        "title": "Permission.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Permission.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "scopes": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "scopes"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Permission.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Permission>"
      },
      "ApiKey.Filter": {
        "type": "object",
        "title": "ApiKey.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "ApiKey.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "key": {
                    "type": "boolean"
                  },
                  "isActive": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "keyType": {
                    "type": "boolean"
                  },
                  "apiKeySubType": {
                    "type": "boolean"
                  },
                  "accessLevel": {
                    "type": "boolean"
                  },
                  "permissionIds": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "key",
                    "isActive",
                    "createdAt",
                    "name",
                    "keyType",
                    "apiKeySubType",
                    "accessLevel",
                    "permissionIds"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "ApiKey.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<ApiKey>"
      },
      "NewOfferApplicability1": {
        "type": "object",
        "title": "NewOfferApplicability",
        "properties": {
          "ratePlanPriceId": {
            "type": "string"
          },
          "addonPriceId": {
            "type": "string"
          },
          "chargePriceId": {
            "type": "string"
          }
        }
      },
      "ApplyTransaction.Filter": {
        "type": "object",
        "title": "ApplyTransaction.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "transactionId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "invoiceId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "transactionId",
                    "subscriptionId",
                    "invoiceId",
                    "accountId",
                    "amount"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "ApplyTransaction.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<ApplyTransaction>"
      },
      "Period.Filter": {
        "type": "object",
        "title": "Period.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Period.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "periodName": {
                    "type": "boolean"
                  },
                  "term": {
                    "type": "boolean"
                  },
                  "period": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "isOpted": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "termLength": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "periodName",
                    "term",
                    "period",
                    "tenantId",
                    "isOpted",
                    "isTrial",
                    "termLength"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Period.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Period>"
      },
      "Charge.Filter": {
        "type": "object",
        "title": "Charge.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "chargeKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "createdTs",
                    "updatedTs",
                    "chargeKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId",
                    "status"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Charge.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Charge>"
      },
      "Charge.Filter1": {
        "type": "object",
        "title": "Charge.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Charge.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "chargeKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "createdTs",
                    "updatedTs",
                    "chargeKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId",
                    "status"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Charge.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Charge>"
      },
      "ChargePrice.Filter": {
        "type": "object",
        "title": "ChargePrice.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "chargeId": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "chargePriceKey": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "price",
                    "currencyCode",
                    "status",
                    "createdTs",
                    "updatedTs",
                    "chargeId",
                    "externalName",
                    "chargePriceKey",
                    "pricingModel",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "taxIncluded",
                    "taxProfileId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "ChargePrice.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<ChargePrice>"
      },
      "CouponSet.Filter": {
        "type": "object",
        "title": "CouponSet.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "CouponSet.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "couponId": {
                    "type": "boolean"
                  },
                  "couponCode": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "couponId",
                    "couponCode",
                    "name",
                    "status",
                    "tenantId",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "CouponSet.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<CouponSet>"
      },
      "EmailPreference.Filter": {
        "type": "object",
        "title": "EmailPreference.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "EmailPreference.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "category": {
                    "type": "boolean"
                  },
                  "emailType": {
                    "type": "boolean"
                  },
                  "sendEmail": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "category",
                    "emailType",
                    "sendEmail",
                    "updatedTs",
                    "description"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "EmailPreference.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<EmailPreference>"
      },
      "Feature.Filter": {
        "type": "object",
        "title": "Feature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "featureKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "featureType": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "defaultValue": {
                    "type": "boolean"
                  },
                  "defaultQuantity": {
                    "type": "boolean"
                  },
                  "minValue": {
                    "type": "boolean"
                  },
                  "maxValue": {
                    "type": "boolean"
                  },
                  "customLevels": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "featureKey",
                    "externalName",
                    "featureType",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "status",
                    "productId",
                    "tenantId",
                    "defaultValue",
                    "defaultQuantity",
                    "minValue",
                    "maxValue",
                    "customLevels",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Feature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Feature>"
      },
      "Feature.Filter1": {
        "type": "object",
        "title": "Feature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Feature.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "featureKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "featureType": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "defaultValue": {
                    "type": "boolean"
                  },
                  "defaultQuantity": {
                    "type": "boolean"
                  },
                  "minValue": {
                    "type": "boolean"
                  },
                  "maxValue": {
                    "type": "boolean"
                  },
                  "customLevels": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "featureKey",
                    "externalName",
                    "featureType",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "status",
                    "productId",
                    "tenantId",
                    "defaultValue",
                    "defaultQuantity",
                    "minValue",
                    "maxValue",
                    "customLevels",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Feature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Feature>"
      },
      "Invoice.Filter": {
        "type": "object",
        "title": "Invoice.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Invoice.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "orderId": {
                    "type": "boolean"
                  },
                  "sourceType": {
                    "type": "boolean"
                  },
                  "debitMemoId": {
                    "type": "boolean"
                  },
                  "createdByUserId": {
                    "type": "boolean"
                  },
                  "invoiceDate": {
                    "type": "boolean"
                  },
                  "dueDate": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "amountWithoutTax": {
                    "type": "boolean"
                  },
                  "taxAmount": {
                    "type": "boolean"
                  },
                  "invoiceNumber": {
                    "type": "boolean"
                  },
                  "taxableAmount": {
                    "type": "boolean"
                  },
                  "cgstAmount": {
                    "type": "boolean"
                  },
                  "sgstAmount": {
                    "type": "boolean"
                  },
                  "igstAmount": {
                    "type": "boolean"
                  },
                  "placeOfSupply": {
                    "type": "boolean"
                  },
                  "supplyType": {
                    "type": "boolean"
                  },
                  "supplierGstin": {
                    "type": "boolean"
                  },
                  "customerGstin": {
                    "type": "boolean"
                  },
                  "gstPricing": {
                    "type": "boolean"
                  },
                  "discountAmount": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "balance": {
                    "type": "boolean"
                  },
                  "path": {
                    "type": "boolean"
                  },
                  "lastEmailSentDate": {
                    "type": "boolean"
                  },
                  "postedDate": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "billingAddress": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "accountId",
                    "subscriptionId",
                    "orderId",
                    "sourceType",
                    "debitMemoId",
                    "createdByUserId",
                    "invoiceDate",
                    "dueDate",
                    "currency",
                    "amountWithoutTax",
                    "taxAmount",
                    "invoiceNumber",
                    "taxableAmount",
                    "cgstAmount",
                    "sgstAmount",
                    "igstAmount",
                    "placeOfSupply",
                    "supplyType",
                    "supplierGstin",
                    "customerGstin",
                    "gstPricing",
                    "discountAmount",
                    "amount",
                    "balance",
                    "path",
                    "lastEmailSentDate",
                    "postedDate",
                    "status",
                    "billingAddress",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Invoice.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Invoice>"
      },
      "CreditMemo.Filter": {
        "type": "object",
        "title": "CreditMemo.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "CreditMemo.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "sourceType": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "invoiceId": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "balance": {
                    "type": "boolean"
                  },
                  "autoPost": {
                    "type": "boolean"
                  },
                  "excludeFromAutoApplyRules": {
                    "type": "boolean"
                  },
                  "comment": {
                    "type": "boolean"
                  },
                  "effectiveDate": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "creditNoteNumber": {
                    "type": "boolean"
                  },
                  "originalInvoiceId": {
                    "type": "boolean"
                  },
                  "originalInvoiceDate": {
                    "type": "boolean"
                  },
                  "taxableAmount": {
                    "type": "boolean"
                  },
                  "taxAmount": {
                    "type": "boolean"
                  },
                  "cgstAmount": {
                    "type": "boolean"
                  },
                  "sgstAmount": {
                    "type": "boolean"
                  },
                  "igstAmount": {
                    "type": "boolean"
                  },
                  "taxRate": {
                    "type": "boolean"
                  },
                  "supplyType": {
                    "type": "boolean"
                  },
                  "scope": {
                    "type": "boolean"
                  },
                  "supplierGstin": {
                    "type": "boolean"
                  },
                  "customerGstin": {
                    "type": "boolean"
                  },
                  "lineItems": {
                    "type": "boolean"
                  },
                  "wallet": {
                    "type": "boolean"
                  },
                  "expiresOn": {
                    "type": "boolean"
                  },
                  "grantPeriodStart": {
                    "type": "boolean"
                  },
                  "grantPeriodEnd": {
                    "type": "boolean"
                  },
                  "transferredFromSubscriptionId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "sourceType",
                    "accountId",
                    "invoiceId",
                    "currency",
                    "amount",
                    "balance",
                    "autoPost",
                    "excludeFromAutoApplyRules",
                    "comment",
                    "effectiveDate",
                    "status",
                    "tenantId",
                    "subscriptionId",
                    "creditNoteNumber",
                    "originalInvoiceId",
                    "originalInvoiceDate",
                    "taxableAmount",
                    "taxAmount",
                    "cgstAmount",
                    "sgstAmount",
                    "igstAmount",
                    "taxRate",
                    "supplyType",
                    "scope",
                    "supplierGstin",
                    "customerGstin",
                    "lineItems",
                    "wallet",
                    "expiresOn",
                    "grantPeriodStart",
                    "grantPeriodEnd",
                    "transferredFromSubscriptionId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "CreditMemo.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<CreditMemo>"
      },
      "Notification.Filter": {
        "type": "object",
        "title": "Notification.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Notification.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "notificationId": {
                    "type": "boolean"
                  },
                  "sender": {
                    "type": "boolean"
                  },
                  "subject": {
                    "type": "boolean"
                  },
                  "body": {
                    "type": "boolean"
                  },
                  "receiver": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "sentTs": {
                    "type": "boolean"
                  },
                  "plannedDate": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "attachments": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "notificationId",
                    "sender",
                    "subject",
                    "body",
                    "receiver",
                    "type",
                    "status",
                    "tenantId",
                    "accountId",
                    "sentTs",
                    "plannedDate",
                    "name",
                    "attachments"
                  ],
                  "example": "notificationId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Notification.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Notification>"
      },
      "Offer.Filter": {
        "type": "object",
        "title": "Offer.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "code": {
                    "type": "boolean"
                  },
                  "discountType": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "extendedTrialPeriod": {
                    "type": "boolean"
                  },
                  "applyOn": {
                    "type": "boolean"
                  },
                  "discountDurationType": {
                    "type": "boolean"
                  },
                  "discountDuration": {
                    "type": "boolean"
                  },
                  "expiryDate": {
                    "type": "boolean"
                  },
                  "maxRedemptionLimit": {
                    "type": "boolean"
                  },
                  "maxRedemptionCount": {
                    "type": "boolean"
                  },
                  "maxRedemptionLimitPerCustomer": {
                    "type": "boolean"
                  },
                  "maxRedemptionCountPerCustomer": {
                    "type": "boolean"
                  },
                  "minimumPurchaseAmount": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "type",
                    "externalName",
                    "name",
                    "description",
                    "code",
                    "discountType",
                    "currency",
                    "amount",
                    "extendedTrialPeriod",
                    "applyOn",
                    "discountDurationType",
                    "discountDuration",
                    "expiryDate",
                    "maxRedemptionLimit",
                    "maxRedemptionCount",
                    "maxRedemptionLimitPerCustomer",
                    "maxRedemptionCountPerCustomer",
                    "minimumPurchaseAmount",
                    "status",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Offer.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Offer>"
      },
      "Offer.Filter1": {
        "type": "object",
        "title": "Offer.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Offer.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "code": {
                    "type": "boolean"
                  },
                  "discountType": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "extendedTrialPeriod": {
                    "type": "boolean"
                  },
                  "applyOn": {
                    "type": "boolean"
                  },
                  "discountDurationType": {
                    "type": "boolean"
                  },
                  "discountDuration": {
                    "type": "boolean"
                  },
                  "expiryDate": {
                    "type": "boolean"
                  },
                  "maxRedemptionLimit": {
                    "type": "boolean"
                  },
                  "maxRedemptionCount": {
                    "type": "boolean"
                  },
                  "maxRedemptionLimitPerCustomer": {
                    "type": "boolean"
                  },
                  "maxRedemptionCountPerCustomer": {
                    "type": "boolean"
                  },
                  "minimumPurchaseAmount": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "type",
                    "externalName",
                    "name",
                    "description",
                    "code",
                    "discountType",
                    "currency",
                    "amount",
                    "extendedTrialPeriod",
                    "applyOn",
                    "discountDurationType",
                    "discountDuration",
                    "expiryDate",
                    "maxRedemptionLimit",
                    "maxRedemptionCount",
                    "maxRedemptionLimitPerCustomer",
                    "maxRedemptionCountPerCustomer",
                    "minimumPurchaseAmount",
                    "status",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Offer.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Offer>"
      },
      "Order.Filter": {
        "type": "object",
        "title": "Order.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Order.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "date": {
                    "type": "boolean"
                  },
                  "scheduleDate": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "invoiceId": {
                    "type": "boolean"
                  },
                  "totalAmount": {
                    "type": "boolean"
                  },
                  "dueAmount": {
                    "type": "boolean"
                  },
                  "subTotal": {
                    "type": "boolean"
                  },
                  "tax": {
                    "type": "boolean"
                  },
                  "discount": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "srcSysCode": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "salesRepId": {
                    "type": "boolean"
                  },
                  "credits": {
                    "type": "boolean"
                  },
                  "debits": {
                    "type": "boolean"
                  },
                  "options": {
                    "type": "boolean"
                  },
                  "workflowProcessInstanceId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "date",
                    "scheduleDate",
                    "accountId",
                    "subscriptionId",
                    "invoiceId",
                    "totalAmount",
                    "dueAmount",
                    "subTotal",
                    "tax",
                    "discount",
                    "status",
                    "srcSysCode",
                    "eventType",
                    "createdTs",
                    "updatedTs",
                    "currency",
                    "salesRepId",
                    "credits",
                    "debits",
                    "options",
                    "workflowProcessInstanceId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Order.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Order>"
      },
      "PaymentGatewaySetting.Filter": {
        "type": "object",
        "title": "PaymentGatewaySetting.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "PaymentGatewaySetting.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "paymentGateway": {
                    "type": "boolean"
                  },
                  "credentials": {
                    "type": "boolean"
                  },
                  "paymentGatewayId": {
                    "type": "boolean"
                  },
                  "successCallbackMethod": {
                    "type": "boolean"
                  },
                  "successCallbackUrl": {
                    "type": "boolean"
                  },
                  "failCallbackMethod": {
                    "type": "boolean"
                  },
                  "failCallbackUrl": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "paymentGateway",
                    "credentials",
                    "paymentGatewayId",
                    "successCallbackMethod",
                    "successCallbackUrl",
                    "failCallbackMethod",
                    "failCallbackUrl"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "PaymentGatewaySetting.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<PaymentGatewaySetting>"
      },
      "PaymentGatewayMaster.Filter": {
        "type": "object",
        "title": "PaymentGatewayMaster.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "PaymentGatewayMaster.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "gatewayName": {
                    "type": "boolean"
                  },
                  "gatewayId": {
                    "type": "boolean"
                  },
                  "gatewayCode": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "supportedCurrencies": {
                    "type": "boolean"
                  },
                  "apiKey": {
                    "type": "boolean"
                  },
                  "apiSecret": {
                    "type": "boolean"
                  },
                  "externalAccountId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "gatewayName",
                    "gatewayId",
                    "gatewayCode",
                    "status",
                    "createdTs",
                    "updatedTs",
                    "supportedCurrencies",
                    "apiKey",
                    "apiSecret",
                    "externalAccountId"
                  ],
                  "example": "gatewayName"
                },
                "uniqueItems": true
              }
            ],
            "title": "PaymentGatewayMaster.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<PaymentGatewayMaster>"
      },
      "PaymentGatewayMetadata.Filter": {
        "type": "object",
        "title": "PaymentGatewayMetadata.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "PaymentGatewayMetadata.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "paymentGateway": {
                    "type": "boolean"
                  },
                  "url": {
                    "type": "boolean"
                  },
                  "cards": {
                    "type": "boolean"
                  },
                  "netBanking": {
                    "type": "boolean"
                  },
                  "upi": {
                    "type": "boolean"
                  },
                  "bankTransfer": {
                    "type": "boolean"
                  },
                  "sepaDirectDebit": {
                    "type": "boolean"
                  },
                  "achDebit": {
                    "type": "boolean"
                  },
                  "amazonPay": {
                    "type": "boolean"
                  },
                  "paypal": {
                    "type": "boolean"
                  },
                  "applePay": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "paymentGateway",
                    "url",
                    "cards",
                    "netBanking",
                    "upi",
                    "bankTransfer",
                    "sepaDirectDebit",
                    "achDebit",
                    "amazonPay",
                    "paypal",
                    "applePay"
                  ],
                  "example": "paymentGateway"
                },
                "uniqueItems": true
              }
            ],
            "title": "PaymentGatewayMetadata.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<PaymentGatewayMetadata>"
      },
      "PaymentMethodMaster.Filter": {
        "type": "object",
        "title": "PaymentMethodMaster.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "PaymentMethodMaster.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "methodId": {
                    "type": "boolean"
                  },
                  "methodName": {
                    "type": "boolean"
                  },
                  "methodCode": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "methodId",
                    "methodName",
                    "methodCode",
                    "status",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "methodId"
                },
                "uniqueItems": true
              }
            ],
            "title": "PaymentMethodMaster.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<PaymentMethodMaster>"
      },
      "Payment.Filter": {
        "type": "object",
        "title": "Payment.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Payment.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "paymentId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "requestedAmount": {
                    "type": "boolean"
                  },
                  "amountPaid": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "acceptPartial": {
                    "type": "boolean"
                  },
                  "expireBy": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "customer": {
                    "type": "boolean"
                  },
                  "paymentLink": {
                    "type": "boolean"
                  },
                  "paymentLinkId": {
                    "type": "boolean"
                  },
                  "referenceId": {
                    "type": "boolean"
                  },
                  "updateTs": {
                    "type": "boolean"
                  },
                  "transactionId": {
                    "type": "boolean"
                  },
                  "paymentMethod": {
                    "type": "boolean"
                  },
                  "paymentDetails": {
                    "type": "boolean"
                  },
                  "paymentDate": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "paymentId",
                    "tenantId",
                    "accountId",
                    "requestedAmount",
                    "amountPaid",
                    "currency",
                    "status",
                    "acceptPartial",
                    "expireBy",
                    "description",
                    "customer",
                    "paymentLink",
                    "paymentLinkId",
                    "referenceId",
                    "updateTs",
                    "transactionId",
                    "paymentMethod",
                    "paymentDetails",
                    "paymentDate"
                  ],
                  "example": "paymentId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Payment.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Payment>"
      },
      "PingResponse": {
        "type": "object",
        "title": "PingResponse",
        "properties": {
          "greeting": {
            "type": "string"
          },
          "date": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "headers": {
            "type": "object",
            "properties": {
              "Content-Type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "RatePlanPriceView.Filter": {
        "type": "object",
        "title": "RatePlanPriceView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "ratePlanKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "productName": {
                    "type": "boolean"
                  },
                  "isVisibleInCheckout": {
                    "type": "boolean"
                  },
                  "redirectUrl": {
                    "type": "boolean"
                  },
                  "planLevel": {
                    "type": "boolean"
                  },
                  "mostPopular": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "customerDescription": {
                    "type": "boolean"
                  },
                  "requireBillingAtSignup": {
                    "type": "boolean"
                  },
                  "autoRenew": {
                    "type": "boolean"
                  },
                  "termLength": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "trialPeriod": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "isAutoCalculated": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "ratePlanPriceKey": {
                    "type": "boolean"
                  },
                  "freeQuantity": {
                    "type": "boolean"
                  },
                  "billingCycle": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "highlightPlan": {
                    "type": "boolean"
                  },
                  "showStrikethrough": {
                    "type": "boolean"
                  },
                  "strikethroughPrice": {
                    "type": "boolean"
                  },
                  "showPrice": {
                    "type": "boolean"
                  },
                  "ctaButtonBehavior": {
                    "type": "boolean"
                  },
                  "ctaButtonLabel": {
                    "type": "boolean"
                  },
                  "customBadge": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "aggregation": {
                    "type": "boolean"
                  },
                  "aggProperty": {
                    "type": "boolean"
                  },
                  "filters": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  },
                  "passThroughTaxable": {
                    "type": "boolean"
                  },
                  "creditPacks": {
                    "type": "boolean"
                  },
                  "grantAmount": {
                    "type": "boolean"
                  },
                  "grantFrequency": {
                    "type": "boolean"
                  },
                  "rollover": {
                    "type": "boolean"
                  },
                  "creditExpiryDays": {
                    "type": "boolean"
                  },
                  "walletZeroBalanceAction": {
                    "type": "boolean"
                  },
                  "autoTopUpPack": {
                    "type": "boolean"
                  },
                  "autoTopUpThreshold": {
                    "type": "boolean"
                  },
                  "commitmentAmount": {
                    "type": "boolean"
                  },
                  "commitmentPeriod": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "ratePlanId",
                    "name",
                    "description",
                    "ratePlanKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "productName",
                    "isVisibleInCheckout",
                    "redirectUrl",
                    "planLevel",
                    "mostPopular",
                    "ratePlanPriceId",
                    "isTrial",
                    "status",
                    "customerDescription",
                    "requireBillingAtSignup",
                    "autoRenew",
                    "termLength",
                    "currencyCode",
                    "billingPeriodId",
                    "price",
                    "mrr",
                    "trialPeriod",
                    "billingPeriod",
                    "isAutoCalculated",
                    "taxIncluded",
                    "pricingModel",
                    "ratePlanPriceKey",
                    "freeQuantity",
                    "billingCycle",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "highlightPlan",
                    "showStrikethrough",
                    "strikethroughPrice",
                    "showPrice",
                    "ctaButtonBehavior",
                    "ctaButtonLabel",
                    "customBadge",
                    "eventType",
                    "aggregation",
                    "aggProperty",
                    "filters",
                    "taxProfileId",
                    "passThroughTaxable",
                    "creditPacks",
                    "grantAmount",
                    "grantFrequency",
                    "rollover",
                    "creditExpiryDays",
                    "walletZeroBalanceAction",
                    "autoTopUpPack",
                    "autoTopUpThreshold",
                    "commitmentAmount",
                    "commitmentPeriod"
                  ],
                  "example": "ratePlanId"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanPriceView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanPriceView>"
      },
      "Product.Filter": {
        "type": "object",
        "title": "Product.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Product.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "effectiveFromDate": {
                    "type": "boolean"
                  },
                  "effectiveToDate": {
                    "type": "boolean"
                  },
                  "logoPath": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "hsnSacCode": {
                    "type": "boolean"
                  },
                  "gstRate": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "productId",
                    "name",
                    "description",
                    "effectiveFromDate",
                    "effectiveToDate",
                    "logoPath",
                    "status",
                    "hsnSacCode",
                    "gstRate"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Product.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Product>"
      },
      "RatePlanPrice.Filter": {
        "type": "object",
        "title": "RatePlanPrice.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "RatePlanPrice.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "productName": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "requireBillingAtSignup": {
                    "type": "boolean"
                  },
                  "termLength": {
                    "type": "boolean"
                  },
                  "autoRenew": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "trialPeriodId": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "isAutoCalculated": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "ratePlanPriceKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "freeQuantity": {
                    "type": "boolean"
                  },
                  "billingCycle": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "highlightPlan": {
                    "type": "boolean"
                  },
                  "showStrikethrough": {
                    "type": "boolean"
                  },
                  "strikethroughPrice": {
                    "type": "boolean"
                  },
                  "showPrice": {
                    "type": "boolean"
                  },
                  "ctaButtonBehavior": {
                    "type": "boolean"
                  },
                  "ctaButtonLabel": {
                    "type": "boolean"
                  },
                  "customBadge": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "aggregation": {
                    "type": "boolean"
                  },
                  "aggProperty": {
                    "type": "boolean"
                  },
                  "filters": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  },
                  "passThroughTaxable": {
                    "type": "boolean"
                  },
                  "creditPacks": {
                    "type": "boolean"
                  },
                  "grantAmount": {
                    "type": "boolean"
                  },
                  "grantFrequency": {
                    "type": "boolean"
                  },
                  "rollover": {
                    "type": "boolean"
                  },
                  "creditExpiryDays": {
                    "type": "boolean"
                  },
                  "walletZeroBalanceAction": {
                    "type": "boolean"
                  },
                  "autoTopUpPack": {
                    "type": "boolean"
                  },
                  "autoTopUpThreshold": {
                    "type": "boolean"
                  },
                  "commitmentAmount": {
                    "type": "boolean"
                  },
                  "commitmentPeriod": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "productId",
                    "tenantId",
                    "isTrial",
                    "status",
                    "productName",
                    "description",
                    "requireBillingAtSignup",
                    "termLength",
                    "autoRenew",
                    "currencyCode",
                    "price",
                    "mrr",
                    "ratePlanId",
                    "trialPeriodId",
                    "billingPeriodId",
                    "isAutoCalculated",
                    "taxIncluded",
                    "pricingModel",
                    "ratePlanPriceKey",
                    "externalName",
                    "freeQuantity",
                    "billingCycle",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "highlightPlan",
                    "showStrikethrough",
                    "strikethroughPrice",
                    "showPrice",
                    "ctaButtonBehavior",
                    "ctaButtonLabel",
                    "customBadge",
                    "eventType",
                    "aggregation",
                    "aggProperty",
                    "filters",
                    "taxProfileId",
                    "passThroughTaxable",
                    "creditPacks",
                    "grantAmount",
                    "grantFrequency",
                    "rollover",
                    "creditExpiryDays",
                    "walletZeroBalanceAction",
                    "autoTopUpPack",
                    "autoTopUpThreshold",
                    "commitmentAmount",
                    "commitmentPeriod"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanPrice.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanPrice>"
      },
      "RatePlanFeature.Filter": {
        "type": "object",
        "title": "RatePlanFeature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "featureId": {
                    "type": "boolean"
                  },
                  "switchValue": {
                    "type": "boolean"
                  },
                  "quantityValue": {
                    "type": "boolean"
                  },
                  "rangeMin": {
                    "type": "boolean"
                  },
                  "rangeMax": {
                    "type": "boolean"
                  },
                  "customValue": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "ratePlanId",
                    "featureId",
                    "switchValue",
                    "quantityValue",
                    "rangeMin",
                    "rangeMax",
                    "customValue",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanFeature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanFeature>"
      },
      "RatePlanFeature.Filter1": {
        "type": "object",
        "title": "RatePlanFeature.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "RatePlanFeature.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "featureId": {
                    "type": "boolean"
                  },
                  "switchValue": {
                    "type": "boolean"
                  },
                  "quantityValue": {
                    "type": "boolean"
                  },
                  "rangeMin": {
                    "type": "boolean"
                  },
                  "rangeMax": {
                    "type": "boolean"
                  },
                  "customValue": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "ratePlanId",
                    "featureId",
                    "switchValue",
                    "quantityValue",
                    "rangeMin",
                    "rangeMax",
                    "customValue",
                    "createdTs",
                    "updatedTs"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanFeature.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanFeature>"
      },
      "RatePlanPriceAddonPriceView.Filter": {
        "type": "object",
        "title": "RatePlanPriceAddonPriceView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "RatePlanPriceAddonPriceView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "addonId": {
                    "type": "boolean"
                  },
                  "addonPriceId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "customerDescription": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "unitOfMeasurement": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "addonPriceKey": {
                    "type": "boolean"
                  },
                  "overage": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "isPriceIncluded": {
                    "type": "boolean"
                  },
                  "applicability": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "ratePlanPriceId",
                    "addonId",
                    "addonPriceId",
                    "name",
                    "description",
                    "customerDescription",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "unitOfMeasurement",
                    "isVisibleInPortal",
                    "price",
                    "quantity",
                    "externalName",
                    "status",
                    "addonPriceKey",
                    "overage",
                    "pricingModel",
                    "currencyCode",
                    "billingPeriodId",
                    "billingPeriod",
                    "isPriceIncluded",
                    "applicability"
                  ],
                  "example": "ratePlanPriceId"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanPriceAddonPriceView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanPriceAddonPriceView>"
      },
      "RatePlan.Filter": {
        "type": "object",
        "title": "RatePlan.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "ratePlanKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "isVisibleInCheckout": {
                    "type": "boolean"
                  },
                  "redirectUrl": {
                    "type": "boolean"
                  },
                  "planLevel": {
                    "type": "boolean"
                  },
                  "mostPopular": {
                    "type": "boolean"
                  },
                  "minimumCommitmentMonths": {
                    "type": "boolean"
                  },
                  "noticePeriodDays": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeType": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeValue": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "createdTs",
                    "updatedTs",
                    "ratePlanKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId",
                    "isVisibleInCheckout",
                    "redirectUrl",
                    "planLevel",
                    "mostPopular",
                    "minimumCommitmentMonths",
                    "noticePeriodDays",
                    "earlyTerminationFeeType",
                    "earlyTerminationFeeValue"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlan.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlan>"
      },
      "RatePlanPriceView.Filter1": {
        "type": "object",
        "title": "RatePlanPriceView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "RatePlanPriceView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "ratePlanKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "productName": {
                    "type": "boolean"
                  },
                  "isVisibleInCheckout": {
                    "type": "boolean"
                  },
                  "redirectUrl": {
                    "type": "boolean"
                  },
                  "planLevel": {
                    "type": "boolean"
                  },
                  "mostPopular": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "customerDescription": {
                    "type": "boolean"
                  },
                  "requireBillingAtSignup": {
                    "type": "boolean"
                  },
                  "autoRenew": {
                    "type": "boolean"
                  },
                  "termLength": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "trialPeriod": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "isAutoCalculated": {
                    "type": "boolean"
                  },
                  "taxIncluded": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "ratePlanPriceKey": {
                    "type": "boolean"
                  },
                  "freeQuantity": {
                    "type": "boolean"
                  },
                  "billingCycle": {
                    "type": "boolean"
                  },
                  "showDescInInvoice": {
                    "type": "boolean"
                  },
                  "showDescInQuote": {
                    "type": "boolean"
                  },
                  "invoiceNote": {
                    "type": "boolean"
                  },
                  "highlightPlan": {
                    "type": "boolean"
                  },
                  "showStrikethrough": {
                    "type": "boolean"
                  },
                  "strikethroughPrice": {
                    "type": "boolean"
                  },
                  "showPrice": {
                    "type": "boolean"
                  },
                  "ctaButtonBehavior": {
                    "type": "boolean"
                  },
                  "ctaButtonLabel": {
                    "type": "boolean"
                  },
                  "customBadge": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "aggregation": {
                    "type": "boolean"
                  },
                  "aggProperty": {
                    "type": "boolean"
                  },
                  "filters": {
                    "type": "boolean"
                  },
                  "taxProfileId": {
                    "type": "boolean"
                  },
                  "passThroughTaxable": {
                    "type": "boolean"
                  },
                  "creditPacks": {
                    "type": "boolean"
                  },
                  "grantAmount": {
                    "type": "boolean"
                  },
                  "grantFrequency": {
                    "type": "boolean"
                  },
                  "rollover": {
                    "type": "boolean"
                  },
                  "creditExpiryDays": {
                    "type": "boolean"
                  },
                  "walletZeroBalanceAction": {
                    "type": "boolean"
                  },
                  "autoTopUpPack": {
                    "type": "boolean"
                  },
                  "autoTopUpThreshold": {
                    "type": "boolean"
                  },
                  "commitmentAmount": {
                    "type": "boolean"
                  },
                  "commitmentPeriod": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "ratePlanId",
                    "name",
                    "description",
                    "ratePlanKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "productName",
                    "isVisibleInCheckout",
                    "redirectUrl",
                    "planLevel",
                    "mostPopular",
                    "ratePlanPriceId",
                    "isTrial",
                    "status",
                    "customerDescription",
                    "requireBillingAtSignup",
                    "autoRenew",
                    "termLength",
                    "currencyCode",
                    "billingPeriodId",
                    "price",
                    "mrr",
                    "trialPeriod",
                    "billingPeriod",
                    "isAutoCalculated",
                    "taxIncluded",
                    "pricingModel",
                    "ratePlanPriceKey",
                    "freeQuantity",
                    "billingCycle",
                    "showDescInInvoice",
                    "showDescInQuote",
                    "invoiceNote",
                    "highlightPlan",
                    "showStrikethrough",
                    "strikethroughPrice",
                    "showPrice",
                    "ctaButtonBehavior",
                    "ctaButtonLabel",
                    "customBadge",
                    "eventType",
                    "aggregation",
                    "aggProperty",
                    "filters",
                    "taxProfileId",
                    "passThroughTaxable",
                    "creditPacks",
                    "grantAmount",
                    "grantFrequency",
                    "rollover",
                    "creditExpiryDays",
                    "walletZeroBalanceAction",
                    "autoTopUpPack",
                    "autoTopUpThreshold",
                    "commitmentAmount",
                    "commitmentPeriod"
                  ],
                  "example": "ratePlanId"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlanPriceView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlanPriceView>"
      },
      "RatePlan.Filter1": {
        "type": "object",
        "title": "RatePlan.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "RatePlan.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "description": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "ratePlanKey": {
                    "type": "boolean"
                  },
                  "externalName": {
                    "type": "boolean"
                  },
                  "isVisibleInPortal": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "isVisibleInCheckout": {
                    "type": "boolean"
                  },
                  "redirectUrl": {
                    "type": "boolean"
                  },
                  "planLevel": {
                    "type": "boolean"
                  },
                  "mostPopular": {
                    "type": "boolean"
                  },
                  "minimumCommitmentMonths": {
                    "type": "boolean"
                  },
                  "noticePeriodDays": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeType": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeValue": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "name",
                    "description",
                    "createdTs",
                    "updatedTs",
                    "ratePlanKey",
                    "externalName",
                    "isVisibleInPortal",
                    "productId",
                    "tenantId",
                    "isVisibleInCheckout",
                    "redirectUrl",
                    "planLevel",
                    "mostPopular",
                    "minimumCommitmentMonths",
                    "noticePeriodDays",
                    "earlyTerminationFeeType",
                    "earlyTerminationFeeValue"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "RatePlan.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<RatePlan>"
      },
      "SmtpServer.Filter": {
        "type": "object",
        "title": "SmtpServer.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "SmtpServer.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "host": {
                    "type": "boolean"
                  },
                  "port": {
                    "type": "boolean"
                  },
                  "secure": {
                    "type": "boolean"
                  },
                  "tls": {
                    "type": "boolean"
                  },
                  "auth": {
                    "type": "boolean"
                  },
                  "user": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "host",
                    "port",
                    "secure",
                    "tls",
                    "auth",
                    "user"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "SmtpServer.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<SmtpServer>"
      },
      "SubscriptionSettings.Filter": {
        "type": "object",
        "title": "SubscriptionSettings.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "SubscriptionSettings.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "settingId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "settingKey": {
                    "type": "boolean"
                  },
                  "settingValue": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "category": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "settingId",
                    "tenantId",
                    "settingKey",
                    "settingValue",
                    "createdTs",
                    "updatedTs",
                    "category"
                  ],
                  "example": "settingId"
                },
                "uniqueItems": true
              }
            ],
            "title": "SubscriptionSettings.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<SubscriptionSettings>"
      },
      "SubscriptionAddonView.Filter": {
        "type": "object",
        "title": "SubscriptionAddonView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "SubscriptionAddonView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "subscriptionAddonId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "price": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "termSubscriptionId": {
                    "type": "boolean"
                  },
                  "addonPriceId": {
                    "type": "boolean"
                  },
                  "addonName": {
                    "type": "boolean"
                  },
                  "attachedAt": {
                    "type": "boolean"
                  },
                  "orderItemId": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "boolean"
                  },
                  "pricingModel": {
                    "type": "boolean"
                  },
                  "applicability": {
                    "type": "boolean"
                  },
                  "priceIncluded": {
                    "type": "boolean"
                  },
                  "overage": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "startDate": {
                    "type": "boolean"
                  },
                  "endDate": {
                    "type": "boolean"
                  },
                  "usedDays": {
                    "type": "boolean"
                  },
                  "totalDays": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "periodRatio": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "subscriptionAddonId",
                    "subscriptionId",
                    "ratePlanPriceId",
                    "price",
                    "quantity",
                    "termSubscriptionId",
                    "addonPriceId",
                    "addonName",
                    "attachedAt",
                    "orderItemId",
                    "currencyCode",
                    "pricingModel",
                    "applicability",
                    "priceIncluded",
                    "overage",
                    "billingPeriodId",
                    "startDate",
                    "endDate",
                    "usedDays",
                    "totalDays",
                    "status",
                    "billingPeriod",
                    "periodRatio"
                  ],
                  "example": "subscriptionAddonId"
                },
                "uniqueItems": true
              }
            ],
            "title": "SubscriptionAddonView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<SubscriptionAddonView>"
      },
      "AuditLog.Filter": {
        "type": "object",
        "title": "AuditLog.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "action": {
                    "type": "boolean"
                  },
                  "actedAt": {
                    "type": "boolean"
                  },
                  "actedOn": {
                    "type": "boolean"
                  },
                  "actionKey": {
                    "type": "boolean"
                  },
                  "entityId": {
                    "type": "boolean"
                  },
                  "actor": {
                    "type": "boolean"
                  },
                  "before": {
                    "type": "boolean"
                  },
                  "after": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "action",
                    "actedAt",
                    "actedOn",
                    "actionKey",
                    "entityId",
                    "actor",
                    "before",
                    "after"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "AuditLog.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<AuditLog>"
      },
      "SubscriptionTerm.Filter": {
        "type": "object",
        "title": "SubscriptionTerm.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "SubscriptionTerm.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "startDate": {
                    "type": "boolean"
                  },
                  "endDate": {
                    "type": "boolean"
                  },
                  "version": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "boolean"
                  },
                  "usedDays": {
                    "type": "boolean"
                  },
                  "totalDays": {
                    "type": "boolean"
                  },
                  "isActive": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "billingCycle": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "trialPeriodId": {
                    "type": "boolean"
                  },
                  "poNumber": {
                    "type": "boolean"
                  },
                  "freePeriod": {
                    "type": "boolean"
                  },
                  "orderItemId": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "priceOverride": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "startDate",
                    "endDate",
                    "version",
                    "subscriptionId",
                    "ratePlanPriceId",
                    "id",
                    "usedDays",
                    "totalDays",
                    "isActive",
                    "isTrial",
                    "billingCycle",
                    "billingPeriodId",
                    "trialPeriodId",
                    "poNumber",
                    "freePeriod",
                    "orderItemId",
                    "amount",
                    "priceOverride",
                    "mrr"
                  ],
                  "example": "startDate"
                },
                "uniqueItems": true
              }
            ],
            "title": "SubscriptionTerm.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<SubscriptionTerm>"
      },
      "Transaction.Filter": {
        "type": "object",
        "title": "Transaction.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "boolean"
                  },
                  "referenceId": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "mode": {
                    "type": "boolean"
                  },
                  "accountName": {
                    "type": "boolean"
                  },
                  "createdOn": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "boolean"
                  },
                  "appliedAmount": {
                    "type": "boolean"
                  },
                  "unappliedAmount": {
                    "type": "boolean"
                  },
                  "transactionDate": {
                    "type": "boolean"
                  },
                  "gatewayId": {
                    "type": "boolean"
                  },
                  "methodId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "transactionId",
                    "referenceId",
                    "amount",
                    "currency",
                    "accountId",
                    "type",
                    "mode",
                    "accountName",
                    "createdOn",
                    "tenantId",
                    "status",
                    "reason",
                    "appliedAmount",
                    "unappliedAmount",
                    "transactionDate",
                    "gatewayId",
                    "methodId"
                  ],
                  "example": "transactionId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Transaction.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Transaction>"
      },
      "SubscriptionView.Filter": {
        "type": "object",
        "title": "SubscriptionView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "SubscriptionView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "productName": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "ratePlanId": {
                    "type": "boolean"
                  },
                  "ratePlanName": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "accountName": {
                    "type": "boolean"
                  },
                  "startDate": {
                    "type": "boolean"
                  },
                  "autoRenew": {
                    "type": "boolean"
                  },
                  "isTrial": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "billingCycle": {
                    "type": "boolean"
                  },
                  "paymentMethodId": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "priceOverride": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "billingPeriodId": {
                    "type": "boolean"
                  },
                  "trialPeriodId": {
                    "type": "boolean"
                  },
                  "trialPeriod": {
                    "type": "boolean"
                  },
                  "billingPeriod": {
                    "type": "boolean"
                  },
                  "autoCollect": {
                    "type": "boolean"
                  },
                  "poNumber": {
                    "type": "boolean"
                  },
                  "autoCloseInvoice": {
                    "type": "boolean"
                  },
                  "autoCloseRenewalInvoice": {
                    "type": "boolean"
                  },
                  "freePeriod": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "invoiceGenerationPreference": {
                    "type": "boolean"
                  },
                  "pauseDate": {
                    "type": "boolean"
                  },
                  "resumeDate": {
                    "type": "boolean"
                  },
                  "orderItemId": {
                    "type": "boolean"
                  },
                  "termSubscriptionId": {
                    "type": "boolean"
                  },
                  "termStartDate": {
                    "type": "boolean"
                  },
                  "termEndDate": {
                    "type": "boolean"
                  },
                  "version": {
                    "type": "boolean"
                  },
                  "usedDays": {
                    "type": "boolean"
                  },
                  "totalDays": {
                    "type": "boolean"
                  },
                  "cancelDate": {
                    "type": "boolean"
                  },
                  "cancelOptions": {
                    "type": "boolean"
                  },
                  "cancellationReason": {
                    "type": "boolean"
                  },
                  "minimumCommitmentMonths": {
                    "type": "boolean"
                  },
                  "noticePeriodDays": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeType": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeValue": {
                    "type": "boolean"
                  },
                  "planMinimumCommitmentMonths": {
                    "type": "boolean"
                  },
                  "planNoticePeriodDays": {
                    "type": "boolean"
                  },
                  "planEarlyTerminationFeeType": {
                    "type": "boolean"
                  },
                  "planEarlyTerminationFeeValue": {
                    "type": "boolean"
                  },
                  "fixedCycles": {
                    "type": "boolean"
                  },
                  "walletExhausted": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "subscriptionId",
                    "productId",
                    "productName",
                    "ratePlanPriceId",
                    "ratePlanId",
                    "ratePlanName",
                    "accountId",
                    "accountName",
                    "startDate",
                    "autoRenew",
                    "isTrial",
                    "tenantId",
                    "currency",
                    "billingCycle",
                    "paymentMethodId",
                    "createdTs",
                    "updatedTs",
                    "amount",
                    "priceOverride",
                    "mrr",
                    "billingPeriodId",
                    "trialPeriodId",
                    "trialPeriod",
                    "billingPeriod",
                    "autoCollect",
                    "poNumber",
                    "autoCloseInvoice",
                    "autoCloseRenewalInvoice",
                    "freePeriod",
                    "status",
                    "invoiceGenerationPreference",
                    "pauseDate",
                    "resumeDate",
                    "orderItemId",
                    "termSubscriptionId",
                    "termStartDate",
                    "termEndDate",
                    "version",
                    "usedDays",
                    "totalDays",
                    "cancelDate",
                    "cancelOptions",
                    "cancellationReason",
                    "minimumCommitmentMonths",
                    "noticePeriodDays",
                    "earlyTerminationFeeType",
                    "earlyTerminationFeeValue",
                    "planMinimumCommitmentMonths",
                    "planNoticePeriodDays",
                    "planEarlyTerminationFeeType",
                    "planEarlyTerminationFeeValue",
                    "fixedCycles",
                    "walletExhausted"
                  ],
                  "example": "subscriptionId"
                },
                "uniqueItems": true
              }
            ],
            "title": "SubscriptionView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<SubscriptionView>"
      },
      "Subscription.Filter": {
        "type": "object",
        "title": "Subscription.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Subscription.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "accountId": {
                    "type": "boolean"
                  },
                  "autoRenew": {
                    "type": "boolean"
                  },
                  "startDate": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "productId": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "paymentMethodId": {
                    "type": "boolean"
                  },
                  "createdTs": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "boolean"
                  },
                  "autoCollect": {
                    "type": "boolean"
                  },
                  "autoCloseInvoice": {
                    "type": "boolean"
                  },
                  "autoCloseRenewalInvoice": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "invoiceGenerationPreference": {
                    "type": "boolean"
                  },
                  "pauseDate": {
                    "type": "boolean"
                  },
                  "resumeDate": {
                    "type": "boolean"
                  },
                  "cancelDate": {
                    "type": "boolean"
                  },
                  "cancelOptions": {
                    "type": "boolean"
                  },
                  "cancellationReason": {
                    "type": "boolean"
                  },
                  "mrr": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "minimumCommitmentMonths": {
                    "type": "boolean"
                  },
                  "noticePeriodDays": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeType": {
                    "type": "boolean"
                  },
                  "earlyTerminationFeeValue": {
                    "type": "boolean"
                  },
                  "fixedCycles": {
                    "type": "boolean"
                  },
                  "walletExhausted": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "accountId",
                    "autoRenew",
                    "startDate",
                    "tenantId",
                    "productId",
                    "currency",
                    "paymentMethodId",
                    "createdTs",
                    "updatedTs",
                    "id",
                    "autoCollect",
                    "autoCloseInvoice",
                    "autoCloseRenewalInvoice",
                    "status",
                    "invoiceGenerationPreference",
                    "pauseDate",
                    "resumeDate",
                    "cancelDate",
                    "cancelOptions",
                    "cancellationReason",
                    "mrr",
                    "amount",
                    "minimumCommitmentMonths",
                    "noticePeriodDays",
                    "earlyTerminationFeeType",
                    "earlyTerminationFeeValue",
                    "fixedCycles",
                    "walletExhausted"
                  ],
                  "example": "accountId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Subscription.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Subscription>"
      },
      "TemplateView.Filter": {
        "type": "object",
        "title": "TemplateView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "TemplateView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "templateId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "content": {
                    "type": "boolean"
                  },
                  "fileName": {
                    "type": "boolean"
                  },
                  "subject": {
                    "type": "boolean"
                  },
                  "fileFormat": {
                    "type": "boolean"
                  },
                  "contentFormat": {
                    "type": "boolean"
                  },
                  "active": {
                    "type": "boolean"
                  },
                  "default": {
                    "type": "boolean"
                  },
                  "isSelected": {
                    "type": "boolean"
                  },
                  "updatedTs": {
                    "type": "boolean"
                  },
                  "recipientEntity": {
                    "type": "boolean"
                  },
                  "category": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "triggerEvent": {
                    "type": "boolean"
                  },
                  "templateSource": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "templateId",
                    "tenantId",
                    "name",
                    "content",
                    "fileName",
                    "subject",
                    "fileFormat",
                    "contentFormat",
                    "active",
                    "default",
                    "isSelected",
                    "updatedTs",
                    "recipientEntity",
                    "category",
                    "type",
                    "triggerEvent",
                    "templateSource"
                  ],
                  "example": "templateId"
                },
                "uniqueItems": true
              }
            ],
            "title": "TemplateView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<TemplateView>"
      },
      "Transaction.Filter1": {
        "type": "object",
        "title": "Transaction.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Transaction.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "boolean"
                  },
                  "referenceId": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "currency": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "boolean"
                  },
                  "mode": {
                    "type": "boolean"
                  },
                  "accountName": {
                    "type": "boolean"
                  },
                  "createdOn": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "boolean"
                  },
                  "appliedAmount": {
                    "type": "boolean"
                  },
                  "unappliedAmount": {
                    "type": "boolean"
                  },
                  "transactionDate": {
                    "type": "boolean"
                  },
                  "gatewayId": {
                    "type": "boolean"
                  },
                  "methodId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "transactionId",
                    "referenceId",
                    "amount",
                    "currency",
                    "accountId",
                    "type",
                    "mode",
                    "accountName",
                    "createdOn",
                    "tenantId",
                    "status",
                    "reason",
                    "appliedAmount",
                    "unappliedAmount",
                    "transactionDate",
                    "gatewayId",
                    "methodId"
                  ],
                  "example": "transactionId"
                },
                "uniqueItems": true
              }
            ],
            "title": "Transaction.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Transaction>"
      },
      "UsageAggregation.Filter": {
        "type": "object",
        "title": "UsageAggregation.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "UsageAggregation.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "addonPriceId": {
                    "type": "boolean"
                  },
                  "billingPeriodStart": {
                    "type": "boolean"
                  },
                  "billingPeriodEnd": {
                    "type": "boolean"
                  },
                  "rawQuantity": {
                    "type": "boolean"
                  },
                  "includedQuantity": {
                    "type": "boolean"
                  },
                  "billableQuantity": {
                    "type": "boolean"
                  },
                  "amount": {
                    "type": "boolean"
                  },
                  "invoiceId": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "orderId": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "ratePlanPriceId": {
                    "type": "boolean"
                  },
                  "priceComponentId": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "subscriptionId",
                    "addonPriceId",
                    "billingPeriodStart",
                    "billingPeriodEnd",
                    "rawQuantity",
                    "includedQuantity",
                    "billableQuantity",
                    "amount",
                    "invoiceId",
                    "createdAt",
                    "orderId",
                    "status",
                    "ratePlanPriceId",
                    "priceComponentId"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "UsageAggregation.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<UsageAggregation>"
      },
      "UsageEventBatch.Filter": {
        "type": "object",
        "title": "UsageEventBatch.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "UsageEventBatch.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "source": {
                    "type": "boolean"
                  },
                  "fileName": {
                    "type": "boolean"
                  },
                  "totalEvents": {
                    "type": "boolean"
                  },
                  "successCount": {
                    "type": "boolean"
                  },
                  "failureCount": {
                    "type": "boolean"
                  },
                  "duplicateCount": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "errorDetails": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "completedAt": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "source",
                    "fileName",
                    "totalEvents",
                    "successCount",
                    "failureCount",
                    "duplicateCount",
                    "status",
                    "errorDetails",
                    "createdAt",
                    "completedAt"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "UsageEventBatch.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<UsageEventBatch>"
      },
      "UsageEventView.Filter": {
        "type": "object",
        "title": "UsageEventView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "UsageEventView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "eventId": {
                    "type": "boolean"
                  },
                  "eventType": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "eventTimestamp": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "properties": {
                    "type": "boolean"
                  },
                  "source": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "accountName": {
                    "type": "boolean"
                  },
                  "subscriptionStatus": {
                    "type": "boolean"
                  },
                  "tenantName": {
                    "type": "boolean"
                  },
                  "subscriptionName": {
                    "type": "boolean"
                  },
                  "termStartDate": {
                    "type": "boolean"
                  },
                  "termEndDate": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "eventId",
                    "eventType",
                    "subscriptionId",
                    "accountId",
                    "tenantId",
                    "quantity",
                    "eventTimestamp",
                    "createdAt",
                    "properties",
                    "source",
                    "status",
                    "accountName",
                    "subscriptionStatus",
                    "tenantName",
                    "subscriptionName",
                    "termStartDate",
                    "termEndDate"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "UsageEventView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<UsageEventView>"
      },
      "UsageView.Filter": {
        "type": "object",
        "title": "UsageView.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "UsageView.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "accountId": {
                    "type": "boolean"
                  },
                  "termSubscriptionId": {
                    "type": "boolean"
                  },
                  "postedAt": {
                    "type": "boolean"
                  },
                  "quantity": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "addonPriceId": {
                    "type": "boolean"
                  },
                  "source": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "subscriptionId": {
                    "type": "boolean"
                  },
                  "appliedTo": {
                    "type": "boolean"
                  },
                  "accountName": {
                    "type": "boolean"
                  },
                  "fromDate": {
                    "type": "boolean"
                  },
                  "toDate": {
                    "type": "boolean"
                  },
                  "subscriptionName": {
                    "type": "boolean"
                  },
                  "tenantName": {
                    "type": "boolean"
                  },
                  "addonName": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "accountId",
                    "termSubscriptionId",
                    "postedAt",
                    "quantity",
                    "tenantId",
                    "addonPriceId",
                    "source",
                    "status",
                    "subscriptionId",
                    "appliedTo",
                    "accountName",
                    "fromDate",
                    "toDate",
                    "subscriptionName",
                    "tenantName",
                    "addonName"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "UsageView.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<UsageView>"
      },
      "User.Filter": {
        "type": "object",
        "title": "User.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "User.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "tenantId": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "boolean"
                  },
                  "lastName": {
                    "type": "boolean"
                  },
                  "email": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "boolean"
                  },
                  "roles": {
                    "type": "boolean"
                  },
                  "keycloakId": {
                    "type": "boolean"
                  },
                  "dailyDigest": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "tenantId",
                    "firstName",
                    "lastName",
                    "email",
                    "status",
                    "id",
                    "roles",
                    "keycloakId",
                    "dailyDigest"
                  ],
                  "example": "tenantId"
                },
                "uniqueItems": true
              }
            ],
            "title": "User.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<User>"
      },
      "Webhook.Filter": {
        "type": "object",
        "title": "Webhook.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "endpointUrl": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "updatedAt": {
                    "type": "boolean"
                  },
                  "eventTypes": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "name",
                    "endpointUrl",
                    "status",
                    "createdAt",
                    "updatedAt",
                    "eventTypes"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Webhook.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Webhook>"
      },
      "Webhook.Filter1": {
        "type": "object",
        "title": "Webhook.Filter",
        "properties": {
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "example": 100
          },
          "skip": {
            "type": "integer",
            "minimum": 0
          },
          "order": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "where": {
            "title": "Webhook.WhereFilter",
            "type": "object",
            "additionalProperties": true
          },
          "fields": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "boolean"
                  },
                  "tenantId": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "boolean"
                  },
                  "endpointUrl": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "boolean"
                  },
                  "createdAt": {
                    "type": "boolean"
                  },
                  "updatedAt": {
                    "type": "boolean"
                  },
                  "eventTypes": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "id",
                    "tenantId",
                    "name",
                    "endpointUrl",
                    "status",
                    "createdAt",
                    "updatedAt",
                    "eventTypes"
                  ],
                  "example": "id"
                },
                "uniqueItems": true
              }
            ],
            "title": "Webhook.Fields"
          }
        },
        "additionalProperties": false,
        "x-typescript-type": "@loopback/repository#Filter<Webhook>"
      }
    }
  },
  "security": [
    {
      "jwt": []
    },
    {
      "apiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://sandbox-api.billhive.in"
    }
  ]
}