{ "swagger": "2.0", "info": { "description": "This is a billing system server", "title": "Billing System API", "contact": {}, "version": "1.0" }, "host": "127.0.0.1:18888", "basePath": "/api/v1/billing", "paths": { "/add_commodity_dimension": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add CommodityDimension", "parameters": [ { "description": "Commodity", "name": "AddCommodityDimension", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityDimension" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CommodityDimension" } } } } }, "/add_commodity_edition": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add AddCommodityEdition", "parameters": [ { "description": "Commodity", "name": "AddCommodityEdition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityEdition" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CommodityEdition" } } } } }, "/add_sku_list": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "AddSkuList", "parameters": [ { "description": "SkuInfo", "name": "AddSkuList", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SkuInfo" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SkuTemplateModify" } } } } } }, "/add_sku_template": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add AddSkuTemplate", "parameters": [ { "description": "Commodity", "name": "AddSkuTemplate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SkuTemplate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SkuTemplate" } } } } }, "/ali_uid/{ali_uid}/aliyun_subscription_record": { "get": { "description": "Get active Aliyun subscription record by AliUid", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AliyunSubscription" ], "summary": "Get Active Aliyun Subscription Record by AliUid", "parameters": [ { "type": "string", "description": "Aliyun User ID", "name": "ali_uid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/aliyun_subscription_record": { "post": { "description": "Create or activate an Aliyun subscription record", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AliyunSubscription" ], "summary": "Create Aliyun Subscription Record", "parameters": [ { "description": "Aliyun Subscription Record", "name": "subscriptionRecord", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/ar_tables": { "get": { "description": "Query AR table records with pagination and optional filters (year, month, is_estimated, tenant_id, payment_type, binded_billing_config_id).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List AR Table Records", "parameters": [ { "type": "integer", "description": "filter by year (used with month, e.g. 2025)", "name": "year", "in": "query" }, { "type": "integer", "description": "filter by month (used with year, e.g. 4)", "name": "month", "in": "query" }, { "type": "boolean", "description": "filter by estimated flag", "name": "is_estimated", "in": "query" }, { "type": "integer", "description": "filter by tenant ID", "name": "tenant_id", "in": "query" }, { "type": "string", "description": "filter by payment type (e.g. stripe, wire_transfer, aws)", "name": "payment_type", "in": "query" }, { "type": "integer", "description": "filter by binded billing config ID", "name": "binded_billing_config_id", "in": "query" }, { "type": "integer", "description": "page number, default=1, min=1, max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page size, default=20, min=1, max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "post": { "description": "Create a new AR table record. All fields except ID (primary key) are supported.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create AR Table Record", "parameters": [ { "description": "AR table record to create", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ARTableCreateInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableRecordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/ar_tables/download": { "get": { "description": "Download AR table records as a CSV file with optional filters (year, month, is_estimated, tenant_id, payment_type, binded_billing_config_id).", "consumes": [ "application/json" ], "summary": "Download AR Table Records as CSV", "parameters": [ { "type": "integer", "description": "filter by year (used with month, e.g. 2025)", "name": "year", "in": "query" }, { "type": "integer", "description": "filter by month (used with year, e.g. 4)", "name": "month", "in": "query" }, { "type": "boolean", "description": "filter by estimated flag", "name": "is_estimated", "in": "query" }, { "type": "integer", "description": "filter by tenant ID", "name": "tenant_id", "in": "query" }, { "type": "string", "description": "filter by payment type (e.g. stripe, wire_transfer, aws)", "name": "payment_type", "in": "query" }, { "type": "integer", "description": "filter by binded billing config ID", "name": "binded_billing_config_id", "in": "query" } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "file" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/ar_tables/export/download": { "get": { "description": "Get a presigned download URL for an async AR table export once it is ready.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get AR Table export download URL", "parameters": [ { "type": "integer", "description": "year", "name": "year", "in": "query", "required": true }, { "type": "integer", "description": "month", "name": "month", "in": "query", "required": true }, { "type": "string", "description": "export type: actual or estimated", "name": "type", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableExportDownloadResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/ar_tables/export/status": { "get": { "description": "Query async AR table export status by year, month and type(actual|estimated).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get AR Table export status", "parameters": [ { "type": "integer", "description": "year", "name": "year", "in": "query", "required": true }, { "type": "integer", "description": "month", "name": "month", "in": "query", "required": true }, { "type": "string", "description": "export type: actual or estimated", "name": "type", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableExportStatusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/ar_tables/{id}": { "get": { "description": "Get a single AR table record by its primary key ID.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get AR Table Record by ID", "parameters": [ { "type": "integer", "description": "AR table record ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableRecordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "put": { "description": "Update an existing AR table record by ID. Only non-zero fields in the request body will be updated. Primary key (ID) is not allowed to be modified.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update AR Table Record", "parameters": [ { "type": "integer", "description": "AR table record ID", "name": "id", "in": "path", "required": true }, { "description": "fields to update (only non-zero fields will be applied)", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ARTableUpdateInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ARTableRecordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "delete": { "description": "Soft-delete an AR table record by its primary key ID.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete AR Table Record", "parameters": [ { "type": "integer", "description": "AR table record ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/auditlog": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List AuditLog", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "operator_id", "name": "operator_id", "in": "path", "required": true }, { "type": "string", "description": "action", "name": "action", "in": "path", "required": true }, { "type": "string", "description": "start_date", "name": "start_date", "in": "path", "required": true }, { "type": "string", "description": "end_date", "name": "end_date", "in": "path", "required": true }, { "type": "string", "description": "page", "name": "page", "in": "path", "required": true }, { "type": "string", "description": "page_size", "name": "page_size", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.AuditLog" } } } } } }, "/billingProfile": { "get": { "description": "This endpoint retrieves the billing profile for an organization.", "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get organization billing profile", "operationId": "Billing_GetOrgBillingProfile", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } } }, "patch": { "description": "This endpoint updates the billing profile for an organization.", "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Update organization billing profile", "operationId": "Billing_UpdateOrgBillingProfile", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "description": "billing profile", "name": "billingProfile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } } } }, "/billing_company": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Billing Company", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BillingCompany" } } } } } }, "/billing_configs/managed_tenants/{tenant_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Billing Configs By Managed Tenant", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingConfig" } } } } }, "/bills/{billedMonth}": { "get": { "description": "This endpoint retrieves the bill for the given month of a specific MSP. You can query a bill up to 6 months prior to the current month. The bill is returned in JSON format.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "MSP" ], "summary": "Return MSP monthly bills", "parameters": [ { "type": "string", "description": "The month of this bill happens for the specified organization. The format is YYYY-MM, for example, '2023-08'.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.MspBills" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsCostExplorer": { "post": { "description": "This endpoint executes a cost explorer query and returns the usage details. Cost explorer query:\n1. Allow users to group costs by category\n2. Allow users to focus on a specific cost item by filter\n3. Allow users to query cost in the specific time range", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get the usage details according to a cost explorer query", "operationId": "Billing_PartnerTrendsOpenAPI", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "description": "Query arguments", "name": "args", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PartnerTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerBillsCostExplorer" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsCostExplorer/args": { "get": { "description": "This endpoint retrieves the basic info for a specific organization, including service info, cloud provider info, project info, and cluster info.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Return basic info of a specific organization, which contains the key info to execute a cost explorer query", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TrendsArgs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsCostExplorer/export": { "post": { "description": "This endpoint executes a cost explorer query and returns the usage details. Cost explorer query:\n1. Allow users to group costs by category\n2. Allow users to focus on a specific cost item by filter\n3. Allow users to query cost in the specific time range", "consumes": [ "application/json" ], "produces": [ "application/json", "text/csv" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Get the usage details according to a cost explorer query", "operationId": "TCPN_GetPartnerTrendsCSV", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "boolean", "description": "withDiscountsAndCredits", "name": "withDiscountsAndCredits", "in": "query", "required": true }, { "description": "Query arguments", "name": "args", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PartnerTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsCostExplorerArgs": { "get": { "description": "This endpoint retrieves the basic information for a specific organization, including service details, cloud provider information, project information, and cluster information.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get basic information of a specific organization, which contains the key information to execute a cost explorer query", "operationId": "Billing_GetPartnerTrendsArgs", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerTrendsArgs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsDetails/{billedMonth}": { "get": { "description": "This endpoint retrieves the bill for the given month of a specific organization with daily usage details. You can query a bill up to 6 months prior to the current month. The bill is returned in JSON format. To use this resource, the requesting API Key must have the Organization Billing Admin or Organization Owner role.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get the monthly bill of the organization with daily usage details", "operationId": "Billing_GetPartnerBillsDetails", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The month of this bill happens for the specified organization, in the format of `YYYY-MM`. For example `2024-08`.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerBillsDetails" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsDetails/{billedMonth}/export": { "get": { "description": "Export Usage CSV", "consumes": [ "application/json" ], "produces": [ "application/json", "text/csv" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Export Usage CSV", "operationId": "TCPN_ExportUsageCSV", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The month of this bill happens for the specified organization, in the format of `YYYY-MM`. For example `2024-08`.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/biz_id/{biz_id}/aliyun_subscription_record": { "get": { "description": "Get Aliyun subscription record by BizId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AliyunSubscription" ], "summary": "Get Aliyun Subscription Record by BizId", "parameters": [ { "type": "string", "description": "Business ID", "name": "biz_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "put": { "description": "Inactive an Aliyun subscription record by biz_id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AliyunSubscription" ], "summary": "Inactive Aliyun Subscription Record", "parameters": [ { "type": "string", "description": "Business ID", "name": "biz_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/boundSupportPlans": { "get": { "description": "This endpoint retrieves the active support plan for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerSupportPlan" ], "summary": "Get organization active support plan", "operationId": "Billing_GetOrgActiveSupportPlanForOpenAPI", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OrgSupportPlanForOpenAPI" } } } } }, "/broadcast_trigger": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Trigger Broadcast", "parameters": [ { "description": "trigger", "name": "trigger", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Trigger" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/broadcast_trigger/{operator}/auth": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Trigger Broadcast Auth", "parameters": [ { "type": "string", "description": "operator", "name": "operator", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/budgets": { "get": { "description": "This endpoint retrieves a list of budgets for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "List organization budgets", "operationId": "Billing_ListOrgBudgets", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } } }, "post": { "description": "This endpoint creates a new budget for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Create a budget for an organization", "operationId": "Billing_CreateBudget", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "description": "budget", "name": "budget", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } } }, "/budgets/{budgetId}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get a budget", "operationId": "Billing_GetBudget", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The ID of the budget.", "name": "budgetId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } }, "delete": { "description": "This endpoint deletes a specific budget for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Delete a budget for an organization", "operationId": "Billing_DeleteBudget", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The ID of the budget to delete. You can get the budget ID from the response of [List organization budgets](#tag/PartnerBilling/operation/Billing_ListOrgBudgets).", "name": "budgetId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "patch": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Update a budget for an organization", "operationId": "Billing_UpdateBudget", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The ID of the budget to delete. You can get the budget ID from the response of [List organization budgets](#tag/PartnerBilling/operation/Billing_ListOrgBudgets).", "name": "budgetId", "in": "path", "required": true }, { "description": "budget", "name": "budget", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } } }, "/bulk_trigger": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Bulk Trigger event", "parameters": [ { "description": "trigger", "name": "trigger", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Trigger" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/create_commodity": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Commodity", "parameters": [ { "description": "Commodity", "name": "CreateCommodity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Commodity" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Commodity" } } } } }, "/credit_risk_levels": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All CreditRisk Level", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditRiskLevel" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create CreditRisk Level", "parameters": [ { "description": "CreditRiskLevel", "name": "CreditRiskLevel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreditRiskLevelInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditRiskLevel" } } } } }, "/credit_risk_levels/{credit_risk_level_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get CreditRisk Level", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditRiskLevel" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update CreditRisk Level", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true }, { "description": "CreditRiskLevel", "name": "CreditRiskLevel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreditRiskLevelInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete CreditRisk Level", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/credit_risk_levels/{credit_risk_level_id}/cost_quota": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Cost Quota", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostQuota" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Set Tenant Cost Quota", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true }, { "description": "CostQuota", "name": "CostQuota", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostQuota" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostQuota" } } } } }, "/credit_risk_levels/{credit_risk_level_id}/risk_close_policy": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Credit Risk Close Policy", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantClosePolicy" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Or Update Credit Risk Close Policy", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true }, { "description": "policy", "name": "policy", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.TenantClosePolicyInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Credit Risk Close Policy", "parameters": [ { "type": "string", "description": "credit_risk_level_id", "name": "credit_risk_level_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/credit_types": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Unit Filter (Credit Type) Tree", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitFilterNode" } } } } }, "/credits": { "get": { "description": "This endpoint retrieves the credits applied to a specific MSP.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "MSP" ], "summary": "Return credits applied to a specific MSP", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.MspCredit" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/customers/{customerId}/partnerConfigs": { "get": { "description": "This endpoint retrieves the partner configuration for a specific Partner.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Return Partner Configs for a Partner", "operationId": "Billing_GetCustomerPartnerConfigs", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "patch": { "description": "This endpoint retrieves the partner configuration for a specific Partner.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Return Partner Configs for a Partner", "operationId": "Billing_UpdateCustomerPartnerConfigs", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "description": "partner_configs", "name": "partnerConfigs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/discounts": { "get": { "description": "This endpoint retrieves a list of discounts available for an organization.", "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "List discounts for an organization", "operationId": "Billing_ListDiscounts", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.DiscountForOpenAPI" } } } } } }, "/discounts/": { "get": { "description": "This endpoint retrieves the discount applied to a specific MSP.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "MSP" ], "summary": "Return discounts applied to a specific MSP", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.MspDiscount" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/events": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Publish Event", "parameters": [ { "description": "payload", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/eventbushandler.Event" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/fx_rates": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "enum": [ "aed", "afn", "all", "amd", "ang", "aoa", "ars", "aud", "awg", "azn", "bam", "bbd", "bdt", "bgn", "bif", "bmd", "bnd", "bob", "brl", "bsd", "bwp", "bzd", "cad", "cdf", "chf", "clp", "cny", "cop", "crc", "cve", "czk", "djf", "dkk", "dop", "dzd", "eek", "egp", "etb", "eur", "fjd", "fkp", "gbp", "gel", "gip", "gmd", "gnf", "gtq", "gyd", "hkd", "hnl", "hrk", "htg", "huf", "idr", "ils", "inr", "isk", "jmd", "jpy", "kes", "kgs", "khr", "kmf", "krw", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "ltl", "lvl", "mad", "mdl", "mga", "mkd", "mnt", "mop", "mro", "mur", "mvr", "mwk", "mxn", "myr", "mzn", "nad", "ngn", "nio", "nok", "npr", "nzd", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rsd", "rub", "rwf", "sar", "sbd", "scr", "sek", "sgd", "shp", "sll", "sos", "srd", "std", "svc", "szl", "thb", "tjs", "top", "try", "ttd", "twd", "tzs", "uah", "ugx", "usd", "uyu", "uzs", "vef", "vnd", "vuv", "wst", "xaf", "xcd", "xof", "xpf", "yer", "zar", "zmw" ], "type": "string", "description": "base", "name": "base", "in": "query" }, { "enum": [ "aed", "afn", "all", "amd", "ang", "aoa", "ars", "aud", "awg", "azn", "bam", "bbd", "bdt", "bgn", "bif", "bmd", "bnd", "bob", "brl", "bsd", "bwp", "bzd", "cad", "cdf", "chf", "clp", "cny", "cop", "crc", "cve", "czk", "djf", "dkk", "dop", "dzd", "eek", "egp", "etb", "eur", "fjd", "fkp", "gbp", "gel", "gip", "gmd", "gnf", "gtq", "gyd", "hkd", "hnl", "hrk", "htg", "huf", "idr", "ils", "inr", "isk", "jmd", "jpy", "kes", "kgs", "khr", "kmf", "krw", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "ltl", "lvl", "mad", "mdl", "mga", "mkd", "mnt", "mop", "mro", "mur", "mvr", "mwk", "mxn", "myr", "mzn", "nad", "ngn", "nio", "nok", "npr", "nzd", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rsd", "rub", "rwf", "sar", "sbd", "scr", "sek", "sgd", "shp", "sll", "sos", "srd", "std", "svc", "szl", "thb", "tjs", "top", "try", "ttd", "twd", "tzs", "uah", "ugx", "usd", "uyu", "uzs", "vef", "vnd", "vuv", "wst", "xaf", "xcd", "xof", "xpf", "yer", "zar", "zmw" ], "type": "string", "description": "target", "name": "target", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.InvoiceAppliedFXRate" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "fx", "name": "fx", "in": "body", "schema": { "$ref": "#/definitions/forms.InvoiceAppliedFXRate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.InvoiceAppliedFXRate" } } } } }, "/global-discounts": { "get": { "description": "List global discount", "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "List Global Discount", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } }, "post": { "description": "Create global discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Create Global Discount", "parameters": [ { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } } }, "/global-discounts/{discount_id}": { "put": { "description": "Update global discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Global Discount", "parameters": [ { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } }, "delete": { "description": "Reclaim global discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Reclaim Global Discount", "parameters": [ { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/invoicedBills/{billedMonth}": { "get": { "description": "This endpoint retrieves the bill for the given month of a specific organization based on the invoice sent date. The bill is returned in JSON format.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Get organization monthly bills based on invoice sent date", "operationId": "Billing_GetPartnerInvoicedBills", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The month for which to retrieve the bill, in the format of `YYYY-MM`. This refers to the month when invoices were sent.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerBillsExplorer" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/invoicedBillsDetails/{billedMonth}": { "get": { "description": "This endpoint retrieves the bill for the given month of a specific organization with daily usage details, based on the invoice sent date.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Get the monthly bill of the organization with daily usage details based on invoice sent date", "operationId": "Billing_GetPartnerInvoicedBillsDetails", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The month of this bill happens for the specified organization, in the format of `YYYY-MM`. This refers to the month when invoices were sent.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerInvoicedBillsDetails" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/invoicedBillsDetails/{billedMonth}/export": { "get": { "description": "Export Usage CSV based on the invoice sent date.", "consumes": [ "application/json" ], "produces": [ "text/csv" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Export Usage CSV based on invoice sent date", "operationId": "TCPN_ExportInvoicedUsageCSV", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "type": "string", "description": "The month of this bill happens for the specified organization, in the format of `YYYY-MM`. This refers to the month when invoices were sent.", "name": "billedMonth", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/invoices": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "description": "brief", "name": "brief", "in": "query" }, { "type": "string", "description": "from, example: 2024-01-01T00:00:00Z", "name": "from", "in": "query" }, { "type": "string", "description": "to, example: 2024-01-01T00:00:00Z", "name": "to", "in": "query" }, { "type": "string", "description": "invoice status", "name": "status", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "invoice statuses", "name": "statuses[]", "in": "query" }, { "type": "string", "description": "active payment type", "name": "active_payment", "in": "query" }, { "type": "string", "description": "comma-separated tenant IDs", "name": "tenant_ids", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.InvoiceForOpsList" } } } } } }, "/marketplace/azure/subscriptions/{payment_code}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Azure subscriptions", "parameters": [ { "type": "string", "description": "payment_code", "name": "payment_code", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SubscriptionList" } } } } }, "/marketplace/azure/token": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Azure Token", "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/marketplace/tenants/{tenant_id}/azure/subscriptions/{subscription_id}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Active Azure Subscription", "parameters": [ { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Azure Subscription", "parameters": [ { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/migrate_tasks/{name}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Run Async Migrate Task", "parameters": [ { "type": "string", "description": "name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/modify_commodity": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "ModifyCommodity", "parameters": [ { "description": "CommodityModify", "name": "ModifyCommodity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityModify" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Commodity" } } } } }, "/modify_commodity_dimension": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "ModifyCommodityDimension", "parameters": [ { "description": "CommodityDimensionModify", "name": "ModifyCommodityDimension", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityDimensionModify" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CommodityDimension" } } } } }, "/modify_commodity_edition": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "ModifyCommodityEdition", "parameters": [ { "description": "CommodityEditionModify", "name": "ModifyCommodityEdition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityEditionModify" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CommodityEdition" } } } } } }, "/modify_commodity_sku_template": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "ModifySkuTemplate", "parameters": [ { "description": "SkuTemplateModify", "name": "ModifySkuTemplate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SkuTemplateModify" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SkuTemplate" } } } } }, "/modify_sku_list": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "ModifySkuList", "parameters": [ { "description": "SkuModify", "name": "ModifySkuList", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SkuModify" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SkuInfo" } } } } } }, "/mspCustomerBills/{billedMonth}/mspCustomers/{mspCustomerId}": { "get": { "description": "This endpoint retrieves the bill for the given month of a specific end customer of MSP. You can query a bill up to 6 months prior to the current month. The bill is returned in JSON format.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "MSP" ], "summary": "Return monthly bills for a specific MSP customer", "parameters": [ { "type": "string", "description": "The month of this bill happens for the specified organization. The format is YYYY-MM, for example, '2023-08'.", "name": "billedMonth", "in": "path", "required": true }, { "type": "string", "description": "ID of the MSP customer.", "name": "mspCustomerId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillsExplorer" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/notifications": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Notifications By WorkflowID", "parameters": [ { "type": "integer", "name": "org_id", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "transaction_id", "in": "query" }, { "type": "integer", "name": "user_id", "in": "query" }, { "type": "string", "name": "work_flow_name_like", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OpsNotifications" } } } } }, "/notifications/workflow_id/{workflow_id}/summary": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Workflow Notifications Summary By WorkflowID", "parameters": [ { "type": "string", "description": "workflow_id", "name": "workflow_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.NotificationsSummary" } } } } } }, "/opened_credits/tenant_ids": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get All Payable TenantIDs", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.TenantID" } } } } } }, "/packages": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Package", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.PackageInfo" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Package", "parameters": [ { "description": "Package", "name": "Package", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PackageInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PackageInfo" } } } } }, "/packages/{package_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Package", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PackageInfo" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Package", "parameters": [ { "type": "string", "description": "package_id", "name": "package_id", "in": "path", "required": true }, { "description": "Package", "name": "Package", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PackageInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PackageInfo" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Package", "parameters": [ { "type": "string", "description": "package_id", "name": "package_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "patch": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Patch Package", "parameters": [ { "type": "string", "description": "package_id", "name": "package_id", "in": "path", "required": true }, { "description": "Package", "name": "Package", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PackageInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PackageInfo" } } } } }, "/partnerConfigs": { "get": { "description": "This endpoint retrieves the partner configuration for a specific Partner.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner" ], "summary": "Get partner configurations", "operationId": "Billing_GetPartnerConfigs", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "patch": { "description": "This endpoint retrieves the partner configuration for a specific Partner.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Update the Partner configurations for a Partner", "operationId": "Billing_UpdatePartnerConfigs", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true }, { "description": "partner_configs", "name": "partnerConfigs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/paying": { "get": { "description": "Returns recent paying tasks and the carryover dashboard summary.", "produces": [ "application/json" ], "tags": [ "StripePaying" ], "summary": "List recent Stripe invoice paying tasks", "parameters": [ { "type": "integer", "default": 20, "description": "Number of payings to return (maximum 100)", "name": "paying_limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.StripePayingListResponse" } } } }, "post": { "description": "Creates a persisted Stripe invoice paying task for the requested month.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePaying" ], "summary": "Create a Stripe invoice paying task", "parameters": [ { "description": "Paying request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.CreatePayingRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/api.StripePayingResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/api.StripePayingErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/api.StripePayingConflictResponse" } } } } }, "/paying/{id}": { "get": { "description": "Returns the full result of one Stripe invoice paying task.", "produces": [ "application/json" ], "tags": [ "StripePaying" ], "summary": "Get a Stripe invoice paying task", "parameters": [ { "type": "integer", "description": "Paying ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.StripePayingDetailResult" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/api.StripePayingErrorResponse" } } } } }, "/payments": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerBilling" ], "summary": "Get active payment method", "operationId": "Billing_GetPartnerPayment", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentForOpenAPI" } } } } }, "/plans/ondemand/global-discounts": { "get": { "description": "Get Global DiscountInfo", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Get Global Discount (deprecated)", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } }, "put": { "description": "Update global discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Global Discount (deprecated)", "parameters": [ { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } } }, "/providers/alicloud/costexplorer/monthly_bills/year/{year}/month/{month}/export": { "post": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Monthly Bills Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": {} } }, "/publicSupportPlans": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner", "PartnerSupportPlan" ], "summary": "List public support plans", "operationId": "Billing_ListPublicSupportPlans", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SupportPlanForOpenAPI" } } } } } }, "/query_commodities": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Query Commodities", "parameters": [ { "description": "CommodityQuery", "name": "CreateCommodity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Commodity" } } } } } }, "/query_commodity_dimensions": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "QueryCommodityDimensions", "parameters": [ { "description": "CommodityDimensionQuery", "name": "QueryCommodityDimensions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityDimensionQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CommodityDimension" } } } } } }, "/query_commodity_editions": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "QueryCommodityEditions", "parameters": [ { "description": "CommodityEditionQuery", "name": "QueryCommodityDimensions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommodityEditionQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CommodityEdition" } } } } } }, "/query_commodity_sku_templates": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "QuerySkuTemplates", "parameters": [ { "description": "SkuTemplateQuery", "name": "QueryCommodityDimensions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SkuTemplateQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SkuTemplate" } } } } } }, "/query_sku_list": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "QuerySkuList", "parameters": [ { "description": "SkuInfoQuery", "name": "QuerySkuList", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SkuInfoQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SkuInfo" } } } } } }, "/recharge_plans": { "get": { "description": "List Recharge Plans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Recharge Plans", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.RechargeCreditsPlan" } } } } } }, "/recharge_plans/{recharge_plan_id}": { "get": { "description": "Get Recharge Plan Info", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Recharge Plan Info", "parameters": [ { "type": "string", "description": "recharge_plan_id", "name": "recharge_plan_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RechargeCreditsPlan" } } } }, "post": { "description": "Create Recharge Plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Recharge Plan", "parameters": [ { "description": "recharge_plan", "name": "recharge_plan", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.RechargeCreditsPlanInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RechargeCreditsPlan" } } } }, "delete": { "description": "Disable Recharge Plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Disable Recharge Plan", "parameters": [ { "type": "string", "description": "recharge_plan_id", "name": "recharge_plan_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "patch": { "description": "Update Recharge Plan Value", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Recharge Plan Value", "parameters": [ { "type": "string", "description": "recharge_plan_id", "name": "recharge_plan_id", "in": "path", "required": true }, { "description": "value", "name": "value", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RechargeCreditsPlan" } } } } }, "/referral/campaigns": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Referral Campaigns", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CampaignListResponse" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Referral Campaign", "parameters": [ { "description": "campaign", "name": "campaign", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateCampaignReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CampaignResponse" } } } } }, "/referral/campaigns/{id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Referral Campaign", "parameters": [ { "type": "integer", "description": "campaign_id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CampaignResponse" } } } } }, "/referral/campaigns/{id}/actions/end": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "End Referral Campaign", "parameters": [ { "type": "integer", "description": "campaign_id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/referral/campaigns/{id}/actions/pause": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Pause Referral Campaign", "parameters": [ { "type": "integer", "description": "campaign_id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/referral/campaigns/{id}/actions/resume": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Resume Referral Campaign", "parameters": [ { "type": "integer", "description": "campaign_id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/referral/reward": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Trigger Referral Reward", "parameters": [ { "description": "reward request", "name": "reward", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ReferralRewardReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ReferralRewardResp" } } } } }, "/sku_groups": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get SKU Groups", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SKUGroup" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add SKU Groups", "parameters": [ { "description": "SKUGroup", "name": "SKUGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SKUGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SKUGroup" } } } } }, "/sku_groups/category": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Category View", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CategoryNode" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add SKU Group Category", "parameters": [ { "description": "CategoryItemShow", "name": "CategoryItemShow", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CategoryItemShow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CategoryItemShow" } } } } }, "/sku_groups/category/{category}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get SKU Group Category", "parameters": [ { "type": "string", "description": "category", "name": "category", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CategoryItemShow" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update SKU Group Category", "parameters": [ { "type": "string", "description": "category", "name": "category", "in": "path", "required": true }, { "description": "CategoryItemShow", "name": "CategoryItemShow", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CategoryItemShow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CategoryItemShow" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete SKU Group Category", "parameters": [ { "type": "string", "description": "category", "name": "category", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/sku_groups/{group_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get SKU Group", "parameters": [ { "type": "string", "description": "group_id", "name": "group_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SKUGroup" } } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update SKU Group", "parameters": [ { "description": "SKUGroup", "name": "SKUGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SKUGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SKUGroup" } } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update SKU Group", "parameters": [ { "type": "string", "description": "group_id", "name": "group_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/spend_limits": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Spend Limits Settings", "parameters": [ { "type": "boolean", "name": "-", "in": "query" }, { "type": "string", "name": "biz_type", "in": "query" }, { "type": "boolean", "name": "has_serverless_free_credits", "in": "query" }, { "type": "integer", "name": "range_id", "in": "query" }, { "type": "string", "name": "range_type", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitSetting" } } } } } }, "/support_plan": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Public Support Plan", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SupportPlan" } } } } } }, "/support_plan/{support_plan_id}": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Public Support Plan", "parameters": [ { "description": "UpdateSupportPlanReq", "name": "UpdateSupportPlanReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SupportPlanInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SupportPlan" } } } } }, "/swaggerDoc": { "get": { "description": "Swagger Doc", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "PartnerPrivateAPI" ], "summary": "Swagger Doc", "operationId": "TCPN_SwaggerDoc", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "/tenant_id/{tenant_id}/aliyun_subscription_record": { "get": { "description": "Get Aliyun subscription record by TenantId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AliyunSubscription" ], "summary": "Get Aliyun Subscription Record by TenantId", "parameters": [ { "type": "string", "description": "Tenant ID", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AliyunSubscriptionRecord" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/tenants/{tenant_id}/billing_action_check": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Billing Action Check", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BillingActionInfo", "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingActionInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingActionCheckResult" } } } } }, "/tenants/{tenant_id}/billing_action_check/_batch": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Billing Action Check", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BillingActionCheckBatchInput", "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingActionCheckBatchInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingActionCheckBatchOutput" } } } } }, "/tenants/{tenant_id}/billing_company": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant BillingCompany", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantBillingCompany" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Tenant BillingCompany", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "TenantBillingCompany", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.TenantBillingCompanyInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantBillingCompany" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/binded_packages": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Binded Package", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BindedPackageInfo" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/binded_support_plan": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Active Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/binded_support_plan/list": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Support Plans", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/commitment_invoices": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Commitment Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "CommitmentInvoiceInput", "name": "CommitmentInvoiceInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommitmentInvoiceInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/contracts": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ContractsResponse" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "Contract", "name": "contract", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ContractInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/contracts/{contract_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "id", "name": "contract_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "description": "Contract", "name": "contract", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ContractInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/contracts/{contract_id}/actions/{action}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Admin Operate Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "enum": [ "create", "submit", "cancel", "delete", "terminate" ], "type": "string", "description": "action", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/contracts/{contract_id}/download": { "get": { "summary": "Download Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExplorerQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerResult" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/bills_details/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "boolean", "description": "with_cppo_discount", "name": "with_cppo_discount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerDetailsResult" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/enabled": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Is Enabled Bills", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillsEnabled" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/monthly_bills/year/{year}/month/{month}/export": { "post": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Monthly Bills Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/monthly_cost/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "boolean", "description": "with_cppo_discount", "name": "with_cppo_discount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.MonthlycostExplorerResult" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/monthly_cost/year/{year}/month/{month}/export": { "post": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Cost Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/open_costs": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Open Costs", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "start date, YYYY-MM-DD", "name": "start_date", "in": "query", "required": true }, { "type": "string", "description": "end date, YYYY-MM-DD", "name": "end_date", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerOpenCostsResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/recalculate/{source_run_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Recalculate Run", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "integer", "description": "source_run_id", "name": "source_run_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerOpenCostsResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/trends": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Trends", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExploreTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExploreTrendsOutput" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/costexplorer/trends/csv": { "post": { "consumes": [ "application/json" ], "produces": [ "text/csv" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "boolean", "description": "display_discounts_and_credits", "name": "with_discounts_and_credits", "in": "query" }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExploreTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/credits": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenants Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "credits", "name": "credits", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateCreditsPackageReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/credits/{credit_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "credit_id", "name": "credit_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/credits/{credit_id}/actions/reclaim": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Reclaim Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "credit_id", "name": "credit_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/credits_summary": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenants Credits Summary", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsSummary" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/discounts": { "get": { "description": "List tenant discount", "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "List Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } }, "post": { "description": "Create tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Create Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/discounts/{discount_id}": { "put": { "description": "Update tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } }, "delete": { "description": "Reclaim tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Reclaim Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Invoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "boolean", "description": "brief", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Invoice" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "CreateInvoiceReq", "name": "CreateInvoiceReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateInvoiceReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Unsent Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}/confirm": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Confirm Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}/modify": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}/recalculate": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Dry Run Recalculate Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RecalculateStartResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}/send": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Send Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/invoices/{invoice_id}/suspend": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Suspend Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Payment Methods", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.PaymentMethod" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/active": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Active PaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentMethod" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/setup/{payment_type}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Setup PaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "payment_type, e.g. wire_transfer", "name": "payment_type", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/customer": { "get": { "description": "GetCustomerInfo", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "GetCustomerInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripeCustomerInfo" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/invoices": { "get": { "description": "ListStripeInvoices", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ListStripeInvoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripeInvoice" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/invoices/{invoice_id}": { "get": { "description": "GetstripeInvoiceDetail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "GetstripeInvoiceDetail", "operationId": "Stripe_GetStripeInvoiceDetail", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripeInvoiceDetail" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/invoices/{invoice_id}/payment_required_notification": { "post": { "description": "manually send notification and email to notify customer need to pay the invoice", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "manually send notification and email to notify customer need to pay the invoice", "operationId": "Stripe_CreditCardPaymentRequiredNotification", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/payment_methods": { "get": { "description": "ListPaymentMethods", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ListPaymentMethods", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/payment_methods/{payment_method_id}": { "put": { "description": "UpdatePaymentMethod", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "UpdatePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true }, { "description": "method", "name": "method", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } }, "delete": { "description": "DeletePaymentMethod", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "DeletePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/payment_methods/{payment_method_id}/default": { "put": { "description": "SetPaymentMethodDefault", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "SetPaymentMethodDefault", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/payment_methods/{payment_method_id}/validate": { "put": { "description": "credit card validation. if pass, attach the paymentMethod to customer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "credit card validation, query after s.SetUpIntent, before s.ConfirmIntent", "operationId": "Stripe_CreditCardValidate", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CardValidateResult" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/setup_intent": { "post": { "description": "SetupIntent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "SetupIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SetupIntent" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/stripe/setup_intent/confirm": { "put": { "description": "ConfirmIntent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ConfirmIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/types": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Payment Types", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.PaymentMethodType" } } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/{payment_type}/code": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Payment Code and SubCode", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "payment_type, e.g. wire_transfer", "name": "payment_type", "in": "path", "required": true }, { "description": "PaymentCodeUpdateQuery", "name": "payment_code_update_query", "in": "body", "schema": { "$ref": "#/definitions/forms.PaymentCodeUpdateQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentMethod" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/payments/{payment_type}/invoiceable": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Payment Invoiceable", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "payment_type, e.g. wire_transfer", "name": "payment_type", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentMethod" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/plans/ondemand/discounts": { "get": { "description": "Get discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Get Tenant DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } }, "put": { "description": "update discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Tenant DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/plans/ondemand/effective-discounts": { "get": { "description": "Get discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Get Tenant Effective DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/recalculate": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Dry Run Recalculate Bills", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "description": "RecalculateBillsPreviewReq", "name": "req", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.RecalculateBillsPreviewReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RecalculateStartResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/recalculate/runs": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Recalculate Runs", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RecalculateRunListResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/recalculate/runs/{source_run_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Recalculate Run", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "string", "description": "source_run_id", "name": "source_run_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.RecalculatePreviewResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/recalculate/runs/{source_run_id}/bills_details": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Recalculate Run Bills Details", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "integer", "description": "source_run_id", "name": "source_run_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerDetailsResult" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/recalculate/runs/{source_run_id}/bills_details/export": { "get": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Export Recalculate Run Bills CSV", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path", "required": true }, { "type": "integer", "description": "source_run_id", "name": "source_run_id", "in": "path", "required": true } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "file" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/users/contracts": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List User View Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ContractsResponse" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/users/contracts/{contract_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get User View Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "id", "name": "contract_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/users/contracts/{contract_id}/actions/{action}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Operate Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "enum": [ "accept", "reject" ], "type": "string", "description": "action", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/billing_config_id/{billing_config_id}/users/discounts": { "get": { "description": "List Discount (User portal)", "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "List Discount (User portal)", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "billing_config_id", "name": "billing_config_id", "in": "path" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } } }, "/tenants/{tenant_id}/billing_configs": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Billing Configs", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BillingConfig" } } } } } }, "/tenants/{tenant_id}/billing_info": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get BillingInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingInformation" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update BillingInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BillingInformation", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingInformationInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingInformation" } } } } }, "/tenants/{tenant_id}/billing_info/sync_on_card_binding": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "SyncBillingInformationOnCardBinding", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BillingInformation", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingInformationInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingInformation" } } } } }, "/tenants/{tenant_id}/binded_packages": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Binded Package", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BindedPackageInfo" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Bind Package", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Package", "name": "Package", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BindedPackageInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedPackageInfo" } } } } }, "/tenants/{tenant_id}/binded_packages/{binded_package_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Binded Package", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedPackageInfo" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Unbind Package", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/binded_packages/{binded_package_id}/charge_credits": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Charge Credits History", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "ChargeCredits", "name": "ChargeCredits", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreditsChargeInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsChargeHistory" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Charge Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "ChargeCredits", "name": "ChargeCredits", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreditsChargeInfoInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedPackageInfo" } } } } }, "/tenants/{tenant_id}/binded_support_plan": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Active Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cancel Activated Tenant Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/binded_support_plan/details": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List activated support plans for tenant. Additionally, return whether the current tenant is still eligible for a free trial.", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlanDetails" } } } } }, "/tenants/{tenant_id}/binded_support_plan/list": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Support Plans", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } } } }, "/tenants/{tenant_id}/binded_support_plan/private": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Tenant Bind Private Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "PrivateSupportPlanReq", "name": "PrivateSupportPlanReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SupportPlanInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } } }, "/tenants/{tenant_id}/binded_support_plan/public": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Tenant Bind Public Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "BindSupportPlanReq", "name": "BindSupportPlanReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BindedSupportPlan" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cancel Tenant Public Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/binded_support_plan/{binded_support_plan_id}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cancel Tenant Support Plan", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/budgets": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Tenant Budgets", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Budget" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Budget", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "budget", "name": "budget", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Budget" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Budget" } } } } }, "/tenants/{tenant_id}/budgets/{budget_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Budget", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Budget" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Budget", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true }, { "description": "name", "name": "budget", "in": "body", "schema": { "$ref": "#/definitions/forms.Budget" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Budget" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Budget", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/budgets/{budget_id}/thresholds": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add Budget Threshold", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitThreshold" } } } } } }, "/tenants/{tenant_id}/budgets/{budget_id}/thresholds/{threshold_id}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Budget Threshold", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true }, { "type": "string", "description": "threshold_id", "name": "threshold_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitThreshold" } } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Budget Threshold", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "budget_id", "name": "budget_id", "in": "path", "required": true }, { "type": "string", "description": "threshold_id", "name": "threshold_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/bulk_trigger": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Bulk Trigger event API", "parameters": [ { "description": "trigger", "name": "trigger", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Trigger" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/closing": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Credit Closure Process Info", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantCloseInfo" } } } } }, "/tenants/{tenant_id}/closing/actions/cancel": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cancel Tenant Closure Process", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/closing/reasons": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Closure Reason", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/tenants/{tenant_id}/closing/reasons/{reason}/actions/run": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Run Tenant Closure Process", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "reason", "name": "reason", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/closing/reasons/{reason}/policies": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Closure Policy", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "reason", "name": "reason", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantClosePolicy" } } } } }, "/tenants/{tenant_id}/commitment_invoices": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Commitment Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "CommitmentInvoiceInput", "name": "CommitmentInvoiceInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CommitmentInvoiceInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/contracts": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ContractsResponse" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Contract", "name": "contract", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ContractInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/contracts/{contract_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "id", "name": "contract_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "description": "Contract", "name": "contract", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.ContractInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/contracts/{contract_id}/actions/{action}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Admin Operate Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "enum": [ "create", "submit", "cancel", "delete", "terminate" ], "type": "string", "description": "action", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/contracts/{contract_id}/download": { "get": { "summary": "Download Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/cost_quota": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Cost Quota", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostQuota" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Set Tenant Cost Quota", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "CostQuota", "name": "CostQuota", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostQuota" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostQuota" } } } } }, "/tenants/{tenant_id}/costexplorer": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExplorerQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerResult" } } } } }, "/tenants/{tenant_id}/costexplorer/args": { "get": { "produces": [ "application/json" ], "summary": "Cost Explorer Args", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerArgs" } } } } }, "/tenants/{tenant_id}/costexplorer/bills_details/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "boolean", "description": "with_cppo_discount", "name": "with_cppo_discount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerDetailsResult" } } } } }, "/tenants/{tenant_id}/costexplorer/enabled": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Is Enabled Bills", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillsEnabled" } } } } }, "/tenants/{tenant_id}/costexplorer/monthly_bills/year/{year}/month/{month}/export": { "post": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Monthly Bills Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/costexplorer/monthly_cost/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "boolean", "description": "with_cppo_discount", "name": "with_cppo_discount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.MonthlycostExplorerResult" } } } } }, "/tenants/{tenant_id}/costexplorer/monthly_cost/year/{year}/month/{month}/export": { "post": { "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "summary": "Cost Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/costexplorer/monthly_usage/app/{app_name}/apps/{app_id}/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "app usage Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "string", "description": "app_name", "name": "app_name", "in": "path", "required": true }, { "type": "string", "description": "app_id", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.AppAPIUsageExplore" } } } } }, "/tenants/{tenant_id}/costexplorer/monthly_usage/dataapi/apps/{app_id}/year/{year}/month/{month}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "DataAPI usage Explorer Monthly", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "string", "description": "app_id", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DataAPIUsageExplore" } } } } }, "/tenants/{tenant_id}/costexplorer/trends": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Explorer Trends", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExploreTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExploreTrendsOutput" } } } } }, "/tenants/{tenant_id}/costexplorer/trends/csv": { "post": { "consumes": [ "application/json" ], "produces": [ "text/csv" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "boolean", "description": "display_discounts_and_credits", "name": "with_discounts_and_credits", "in": "query" }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExploreTrendsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "/tenants/{tenant_id}/cppo_billing_config": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create CPPO Billing Config", "parameters": [ { "description": "CPPOBillingConfig", "name": "CPPOBillingConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CPPOBillingConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/credit_risk_level": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant CreditRisk Level", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditRiskLevel" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Tenant CreditRisk Level", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "CreditRiskLevel", "name": "CreditRiskLevel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreditRiskLevelIDInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/credits": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenants Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "credits", "name": "credits", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateCreditsPackageReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "/tenants/{tenant_id}/credits/{credit_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "credit_id", "name": "credit_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsPackage" } } } } }, "/tenants/{tenant_id}/credits/{credit_id}/actions/reclaim": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Reclaim Credits", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "credit_id", "name": "credit_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/credits_summary": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenants Credits Summary", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CreditsSummary" } } } } }, "/tenants/{tenant_id}/discounts": { "get": { "description": "List tenant discount", "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "List Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } }, "post": { "description": "Create tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Create Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } } }, "/tenants/{tenant_id}/discounts/{discount_id}": { "put": { "description": "Update tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Discount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Discount" } } } }, "delete": { "description": "Reclaim tenant discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Reclaim Tenant Discount", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "discount_id", "name": "discount_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/internal/costexplorer": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Internal Cost Explorer", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExplorerInternalQuery" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerResult" } } } } }, "/tenants/{tenant_id}/internal/costexplorer/v2": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Complete Cost Explorer", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Query", "name": "Query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CostExplorerQueryV2" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.CostExplorerResult" } } } } }, "/tenants/{tenant_id}/invoices": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Invoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "boolean", "description": "brief", "name": "brief", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Invoice" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "CreateInvoiceReq", "name": "CreateInvoiceReq", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.CreateInvoiceReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/invoices/{invoice_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Unsent Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/invoices/{invoice_id}/confirm": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Confirm Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/invoices/{invoice_id}/modify": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/invoices/{invoice_id}/send": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Send Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/invoices/{invoice_id}/suspend": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Suspend Invoice", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "invoice_id", "name": "invoice_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Invoice" } } } } }, "/tenants/{tenant_id}/mcpo_billing_config": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create CPPO Billing Config", "parameters": [ { "description": "MCPOBillingConfig", "name": "MCPOBillingConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.MCPOBillingConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/measures": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Units", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Cost", "name": "Cost", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitCostsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitCosts" } } } } }, "/tenants/{tenant_id}/measures/dryrun": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Cost Units Dryrun", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Cost", "name": "Cost", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitCostsInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitCosts" } } } } }, "/tenants/{tenant_id}/notifications/notification_id/{notification_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Notifications by Notification_id", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "notification_id", "name": "notification_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Notification" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Mark User Notifications As Read", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "notification_id", "name": "notification_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Notifications" } } } } }, "/tenants/{tenant_id}/notifications/{query_type}/page/{page}/page_size/{page_size}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Notifications", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "query_type", "name": "query_type", "in": "path", "required": true }, { "type": "integer", "description": "page", "name": "page", "in": "path", "required": true }, { "type": "integer", "description": "page_size", "name": "page_size", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Notifications" } } } } }, "/tenants/{tenant_id}/notifications/{type}/notification_id/{notification_id}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Mark User Notifications As Seen", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "type", "name": "type", "in": "path", "required": true }, { "type": "string", "description": "notification_id", "name": "notification_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Notifications" } } } } }, "/tenants/{tenant_id}/payments": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Payment Methods", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.PaymentMethod" } } } } } }, "/tenants/{tenant_id}/payments/active": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Active PaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentMethod" } } } } }, "/tenants/{tenant_id}/payments/setup/{payment_type}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Setup PaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_type, e.g. wire_transfer", "name": "payment_type", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/payments/stripe/customer": { "get": { "description": "GetCustomerInfo", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "GetCustomerInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripeCustomerInfo" } } } } }, "/tenants/{tenant_id}/payments/stripe/invoices": { "get": { "description": "ListStripeInvoices", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ListStripeInvoices", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripeInvoice" } } } } } }, "/tenants/{tenant_id}/payments/stripe/payment_methods": { "get": { "description": "ListPaymentMethods", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ListPaymentMethods", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } } } }, "/tenants/{tenant_id}/payments/stripe/payment_methods/{payment_method_id}": { "put": { "description": "UpdatePaymentMethod", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "UpdatePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true }, { "description": "method", "name": "method", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.StripePaymentMethod" } } } }, "delete": { "description": "DeletePaymentMethod", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "DeletePaymentMethod", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/payments/stripe/payment_methods/{payment_method_id}/default": { "put": { "description": "SetPaymentMethodDefault", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "SetPaymentMethodDefault", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "payment_method_id", "name": "payment_method_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/payments/stripe/setup_intent": { "post": { "description": "SetupIntent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "SetupIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SetupIntent" } } } } }, "/tenants/{tenant_id}/payments/stripe/setup_intent/confirm": { "put": { "description": "ConfirmIntent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "StripePayment" ], "summary": "ConfirmIntent", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/payments/types": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Tenant Payment Types", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.PaymentMethodType" } } } } } }, "/tenants/{tenant_id}/plans": { "get": { "description": "Get tenant effective plan info by tenant id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Plan" ], "summary": "Get Tenant Plan Info", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantPlanInfo" } } } } }, "/tenants/{tenant_id}/plans/dev_tier/notify_dev_tier_cluster_created": { "put": { "description": "Notify Dev Tier Cluster Created", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Plan" ], "summary": "Notify Dev Tier Cluster Created", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/plans/ondemand/discounts": { "get": { "description": "Get discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Get Tenant DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } }, "put": { "description": "update discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Update Tenant DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "discount", "name": "discount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } } }, "/tenants/{tenant_id}/plans/ondemand/effective-discounts": { "get": { "description": "Get discount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "Get Tenant Effective DiscountInfo", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.DiscountInfo" } } } } }, "/tenants/{tenant_id}/recharge_plans/{tenant_recharge_plan_id}": { "get": { "description": "Get Recharge Plan Info", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Recharge Plan Info", "parameters": [ { "type": "string", "description": "tenant_recharge_plan_id", "name": "tenant_recharge_plan_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantRechargeCreditsPlan" } } } }, "delete": { "description": "Disable Recharge Plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Disable Tenant Recharge Plan", "parameters": [ { "type": "string", "description": "tenant_recharge_plan_id", "name": "tenant_recharge_plan_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/referral/code": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get or Create Referral Code", "parameters": [ { "type": "integer", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ReferralCodeResponse" } } } } }, "/tenants/{tenant_id}/risk_close_policy": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Credit Risk Close Policy", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantClosePolicy" } } } } }, "/tenants/{tenant_id}/spend_limits": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Tenant Spend Limit Settings", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "boolean", "name": "-", "in": "query" }, { "type": "string", "name": "biz_type", "in": "query" }, { "type": "boolean", "name": "has_serverless_free_credits", "in": "query" }, { "type": "integer", "name": "range_id", "in": "query" }, { "type": "string", "name": "range_type", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitSetting" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Spend Limit Settings", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "setting", "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SpendLimitSettingInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SpendLimitSetting" } } } } }, "/tenants/{tenant_id}/spend_limits/info": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Tenant Spend Limits Info", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "boolean", "name": "-", "in": "query" }, { "type": "string", "name": "biz_type", "in": "query" }, { "type": "boolean", "name": "has_serverless_free_credits", "in": "query" }, { "type": "integer", "name": "range_id", "in": "query" }, { "type": "string", "name": "range_type", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitInfo" } } } } } }, "/tenants/{tenant_id}/spend_limits/{spend_limit_setting_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Spend Limit Setting", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "spend_limit_setting_id", "name": "spend_limit_setting_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SpendLimitSetting" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Spend Limit Settings", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "spend_limit_setting_id", "name": "spend_limit_setting_id", "in": "path", "required": true }, { "description": "setting", "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SpendLimitSettingInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SpendLimitSetting" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Spend Limit Setting", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "spend_limit_setting_id", "name": "spend_limit_setting_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/spend_limits/{spend_limit_setting_id}/info": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Spend Limit Info", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "spend_limit_setting_id", "name": "spend_limit_setting_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SpendLimitInfo" } } } } }, "/tenants/{tenant_id}/subcriptions": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List All Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Subscription" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "Subscription", "name": "Subscription", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SubscriptionInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Subscription" } } } } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Subscription" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true }, { "description": "Subscription", "name": "Subscription", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SubscriptionInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Subscription" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}/actions/accept": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Accept Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}/actions/download": { "get": { "summary": "Download Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": {} } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}/actions/reject": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Reject Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true }, { "description": "SubscriptionChange", "name": "SubscriptionChange", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SubscriptionChange" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}/actions/submit": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Submit Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "SubscriptionChange", "name": "SubscriptionChange", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SubscriptionChange" } }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/subcriptions/{subscription_id}/actions/suspend": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Suspend Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "description": "SubscriptionChange", "name": "SubscriptionChange", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.SubscriptionChange" } }, { "type": "string", "description": "subscription_id", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/submited_subcriptions": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Submited Subscription", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Subscription" } } } } } }, "/tenants/{tenant_id}/switch/card/validate/is_allowed": { "get": { "description": "access control of function: credit card validation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Switch" ], "summary": "Is Credit Card Validation Required", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SwitchResponse" } } } } }, "/tenants/{tenant_id}/switch/card/validation/required": { "get": { "description": "access control of function: credit card validation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Switch" ], "summary": "Is Credit Card Validation Required", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.SwitchResponse" } } } } }, "/tenants/{tenant_id}/tax_rates": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Tenant TaxRate", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TaxRate" } } } } }, "/tenants/{tenant_id}/tenant_risk_close": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Tenant Credit Risk Close Info", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.TenantCloseInfo" } } } } }, "/tenants/{tenant_id}/tenant_risk_close/actions/cancel": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Run Tenant Credit Risk Close", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/tenant_risk_close/actions/run": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Run Tenant Credit Risk Close", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/users/contracts": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List User View Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "page,default=1,min=1,max=100", "name": "page", "in": "query" }, { "type": "integer", "description": "page_size,default=20,min=1,max=100", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.ContractsResponse" } } } } }, "/tenants/{tenant_id}/users/contracts/{contract_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get User View Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "id", "name": "contract_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Contract" } } } } }, "/tenants/{tenant_id}/users/contracts/{contract_id}/actions/{action}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Operate Contract", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true }, { "type": "integer", "description": "contract_id", "name": "contract_id", "in": "path", "required": true }, { "enum": [ "accept", "reject" ], "type": "string", "description": "action", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/tenants/{tenant_id}/users/discounts": { "get": { "description": "List Discount (User portal)", "produces": [ "application/json" ], "tags": [ "DiscountInfo" ], "summary": "List Discount (User portal)", "parameters": [ { "type": "string", "description": "tenant_id", "name": "tenant_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } } } } } }, "/unit_filters": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Unit Filter (Credit Type) Tree", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitFilterNode" } } } } }, "/unit_filters/quick_selections/{target}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Unit Filter Quick Selection", "parameters": [ { "description": "target", "name": "target", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } } } } } }, "/units": { "get": { "description": "Return units matching group_id or the group's non-empty category. Without group_id, return all units.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Units", "parameters": [ { "type": "integer", "description": "group_id", "name": "group_id", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitInfo" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Unit", "parameters": [ { "description": "unit", "name": "unit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitInfo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } } }, "/units/": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "List Units By GroupID", "parameters": [ { "type": "string", "description": "group_id", "name": "group_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitInfo" } } } } } }, "/units/_bulk": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Bulk CreateOrUpdate Unit", "parameters": [ { "description": "units", "name": "unit", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitInfo" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/units/_create_by_group": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Unit By Group", "parameters": [ { "description": "UnitByGroup", "name": "UnitByGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitByGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } } }, "/units/_create_by_group/dryrun": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Unit By Group", "parameters": [ { "description": "UnitByGroup", "name": "UnitByGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitByGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } } }, "/units/_export": { "get": { "description": "Export units selected by group_id or the group's non-empty category. Without group_id, the CSV contains only its header. SQL NULL values are represented as \\N.", "produces": [ "text/csv" ], "summary": "Export Units CSV", "parameters": [ { "type": "integer", "description": "group_id", "name": "group_id", "in": "query" } ], "responses": { "200": { "description": "units CSV file", "schema": { "type": "file" } } } } }, "/units/_import": { "post": { "description": "Atomically upsert units by unit_key. The endpoint accepts a multipart file field named file or a raw text/csv body.", "consumes": [ "multipart/form-data", "text/csv" ], "produces": [ "application/json" ], "summary": "Import Units CSV", "parameters": [ { "type": "file", "description": "units CSV file (required for multipart requests)", "name": "file", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitCSVImportResult" } } } } }, "/units/network/{provider}/{region}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Add Region NetWork Unit", "parameters": [ { "type": "string", "description": "Provider", "name": "provider", "in": "path", "required": true }, { "type": "string", "description": "Region", "name": "region", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/units/{unit_key}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Unit", "parameters": [ { "type": "string", "description": "UnitKey", "name": "unit_key", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Unit", "parameters": [ { "type": "string", "description": "UnitKey", "name": "unit_key", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Delete Unit", "parameters": [ { "type": "string", "description": "UnitKey", "name": "unit_key", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "patch": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Patch Unit", "parameters": [ { "type": "string", "description": "UnitKey", "name": "unit_key", "in": "path", "required": true }, { "description": "unit patch", "name": "unit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.UnitPatch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.UnitInfo" } } } } }, "/userManualDoc": { "get": { "description": "User Manual", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "PartnerPrivateAPI" ], "summary": "User Manual", "operationId": "TCPN_UserManual", "parameters": [ { "type": "string", "description": "org_id", "name": "accessOrgId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "/worker/run": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Worker Run Action", "parameters": [ { "description": "WorkerTaskAction", "name": "WorkerAction", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.WorkerTaskAction" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/worker/subtask/run": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Worker Run Action", "parameters": [ { "description": "WorkerSubTaskAction", "name": "WorkerAction", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.WorkerSubTaskAction" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } } }, "/workflow": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Update Workflow", "parameters": [ { "description": "Workflow", "name": "workflow", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Workflow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Workflow" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Create Workflow", "parameters": [ { "description": "Workflow", "name": "workflow", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Workflow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Workflow" } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "DELETE Workflow", "parameters": [ { "description": "Workflow", "name": "workflow", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.Workflow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Workflow" } } } } }, "/workflow/page/{page}/page_size/{page_size}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get WorkFlows", "parameters": [ { "type": "string", "description": "page", "name": "page", "in": "path", "required": true }, { "type": "string", "description": "page_size", "name": "page_size", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.WorkFlows" } } } } }, "/workflow/workflow_id/{workflow_id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Get Workflow", "parameters": [ { "type": "string", "description": "workflow_id", "name": "workflow_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Workflow" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "Duplicate Workflow", "parameters": [ { "type": "string", "description": "workflow_id", "name": "workflow_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.Workflow" } } } } } }, "definitions": { "api.CreatePayingRequest": { "type": "object", "required": [ "month" ], "properties": { "force": { "type": "boolean", "example": false }, "month": { "type": "string", "example": "2026-06" } } }, "api.StripePayingCarryoverSummary": { "type": "object", "properties": { "oldest_first_carry_month": { "type": "string" }, "total_amount": { "type": "string" }, "total_count": { "type": "integer" } } }, "api.StripePayingConflictResponse": { "type": "object", "properties": { "error": { "type": "string" }, "existing_paying": { "$ref": "#/definitions/api.StripePayingResponse" }, "message": { "type": "string" } } }, "api.StripePayingDetailResponse": { "type": "object", "properties": { "completed_at": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "duration_seconds": { "type": "integer" }, "error_message": { "type": "string" }, "month": { "type": "string" }, "paying_id": { "type": "integer" }, "picked_up_at": { "type": "string" }, "result": {}, "status": { "type": "string" } } }, "api.StripePayingDetailResult": { "type": "object", "properties": { "paying": { "$ref": "#/definitions/api.StripePayingDetailResponse" } } }, "api.StripePayingErrorResponse": { "type": "object", "properties": { "code": { "type": "string" }, "error": { "type": "string" }, "message": { "type": "string" } } }, "api.StripePayingListResponse": { "type": "object", "properties": { "carryover_summary": { "$ref": "#/definitions/api.StripePayingCarryoverSummary" }, "payings": { "type": "array", "items": { "$ref": "#/definitions/api.StripePayingResponse" } } } }, "api.StripePayingResponse": { "type": "object", "properties": { "completed_at": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "duration_seconds": { "type": "integer" }, "error_message": { "type": "string" }, "month": { "type": "string" }, "paying_id": { "type": "integer" }, "picked_up_at": { "type": "string" }, "result": {}, "status": { "type": "string" } } }, "billing_errors.BaseError": { "type": "object", "properties": { "code": { "type": "string" }, "error": {}, "msgPrefix": { "type": "string" }, "status": { "type": "integer" } } }, "eventbushandler.Event": { "type": "object", "properties": { "eventData": {}, "eventID": { "type": "string" }, "eventType": { "type": "string" } } }, "forms.ARTableCreateInput": { "type": "object", "required": [ "bill_month", "binded_billing_config_id", "payment_type", "tenant_id" ], "properties": { "bill_month": { "type": "string" }, "binded_billing_config_id": { "type": "string", "example": "0" }, "byoc_allocated_loss": { "type": "string" }, "channel_loss_amount": { "type": "string" }, "cppo_discountable_product_amount": { "type": "string" }, "cppo_non_discountable_product_amount": { "type": "string" }, "dedicated_accrual_amount": { "type": "string" }, "dedicated_allocated_loss": { "type": "string" }, "end_date": { "type": "string" }, "essential_allocated_loss": { "type": "string" }, "invoice_amount": { "type": "string" }, "is_estimated": { "type": "boolean" }, "lake_allocated_loss": { "type": "string" }, "marketplace_amount": { "type": "string" }, "partner_id": { "type": "string" }, "payment_code": { "type": "string" }, "payment_type": { "type": "string" }, "premium_allocated_loss": { "type": "string" }, "prepayment_credits": { "type": "string" }, "raw_byoc_amount": { "type": "string" }, "raw_byoc_customer_success_amount": { "type": "string" }, "raw_byoc_program_credits_amount": { "type": "string" }, "raw_byoc_redeem_credits_amount": { "type": "string" }, "raw_dedicated_amount": { "type": "string" }, "raw_dedicated_customer_success_amount": { "type": "string" }, "raw_dedicated_program_credits_amount": { "type": "string" }, "raw_dedicated_redeem_credits_amount": { "type": "string" }, "raw_essential_amount": { "type": "string" }, "raw_essential_customer_success_amount": { "type": "string" }, "raw_essential_program_credits_amount": { "type": "string" }, "raw_essential_redeem_credits_amount": { "type": "string" }, "raw_lake_amount": { "type": "string" }, "raw_lake_customer_success_amount": { "type": "string" }, "raw_lake_program_credits_amount": { "type": "string" }, "raw_lake_redeem_credits_amount": { "type": "string" }, "raw_premium_amount": { "type": "string" }, "raw_premium_customer_success_amount": { "type": "string" }, "raw_premium_program_credits_amount": { "type": "string" }, "raw_premium_redeem_credits_amount": { "type": "string" }, "raw_serverless_amount": { "type": "string" }, "raw_serverless_customer_success_amount": { "type": "string" }, "raw_serverless_program_credits_amount": { "type": "string" }, "raw_serverless_redeem_credits_amount": { "type": "string" }, "raw_starter_amount": { "type": "string" }, "raw_starter_customer_success_amount": { "type": "string" }, "raw_starter_program_credits_amount": { "type": "string" }, "raw_starter_redeem_credits_amount": { "type": "string" }, "raw_support_amount": { "type": "string" }, "raw_support_customer_success_amount": { "type": "string" }, "raw_support_program_credits_amount": { "type": "string" }, "raw_support_redeem_credits_amount": { "type": "string" }, "serverless_allocated_loss": { "type": "string" }, "start_date": { "type": "string" }, "starter_allocated_loss": { "type": "string" }, "stripe_amount": { "type": "array", "items": { "type": "string" } }, "stripe_amount_including_tax": { "type": "array", "items": { "type": "string" } }, "stripe_invoice": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_finalized_date": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_number": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid_date": { "type": "array", "items": { "type": "string" } }, "stripe_tax_rate": { "type": "array", "items": { "type": "string" } }, "support_accrual_amount": { "type": "string" }, "support_allocated_loss": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "total_amount": { "type": "string" }, "wire_transfer_amount": { "type": "string" } } }, "forms.ARTableExportDownloadResponse": { "type": "object", "properties": { "key": { "type": "string" }, "url": { "type": "string" } } }, "forms.ARTableExportStatusResponse": { "type": "object", "properties": { "key": { "type": "string" }, "started_at": { "type": "string" }, "status": { "type": "string" }, "timeout_at": { "type": "string" } } }, "forms.ARTableListResponse": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "records": { "type": "array", "items": { "$ref": "#/definitions/forms.ARTableRecordResponse" } }, "total_results": { "type": "integer" } } }, "forms.ARTableRecordResponse": { "type": "object", "properties": { "bill_month": { "type": "string", "example": "2025-04" }, "binded_billing_config_id": { "type": "string", "example": "1" }, "byoc_allocated_loss": { "type": "string" }, "byoc_amount": { "type": "string" }, "channel_loss_amount": { "type": "string" }, "cppo_discountable_product_amount": { "type": "string" }, "cppo_non_discountable_product_amount": { "type": "string" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "dedicated_accrual_amount": { "type": "string" }, "dedicated_allocated_loss": { "type": "string" }, "dedicated_amount": { "type": "string" }, "end_date": { "type": "string", "example": "2025-04-30" }, "essential_allocated_loss": { "type": "string" }, "essential_amount": { "type": "string" }, "id": { "type": "string", "example": "1" }, "invoice_amount": { "type": "string", "example": "150.00" }, "is_estimated": { "type": "boolean", "example": false }, "lake_allocated_loss": { "type": "string" }, "lake_amount": { "type": "string" }, "marketplace_amount": { "type": "string", "example": "50.00" }, "partner_id": { "type": "string", "example": "partner_abc" }, "payment_code": { "type": "string", "example": "cus_abc123" }, "payment_type": { "type": "string", "example": "stripe" }, "premium_allocated_loss": { "type": "string" }, "premium_amount": { "type": "string" }, "prepayment_credits": { "type": "string", "example": "20.00" }, "raw_byoc_amount": { "type": "string" }, "raw_byoc_customer_success_amount": { "type": "string" }, "raw_byoc_program_credits_amount": { "type": "string" }, "raw_byoc_redeem_credits_amount": { "type": "string" }, "raw_dedicated_amount": { "type": "string" }, "raw_dedicated_customer_success_amount": { "type": "string" }, "raw_dedicated_program_credits_amount": { "type": "string" }, "raw_dedicated_redeem_credits_amount": { "type": "string" }, "raw_essential_amount": { "type": "string" }, "raw_essential_customer_success_amount": { "type": "string" }, "raw_essential_program_credits_amount": { "type": "string" }, "raw_essential_redeem_credits_amount": { "type": "string" }, "raw_lake_amount": { "type": "string" }, "raw_lake_customer_success_amount": { "type": "string" }, "raw_lake_program_credits_amount": { "type": "string" }, "raw_lake_redeem_credits_amount": { "type": "string" }, "raw_premium_amount": { "type": "string" }, "raw_premium_customer_success_amount": { "type": "string" }, "raw_premium_program_credits_amount": { "type": "string" }, "raw_premium_redeem_credits_amount": { "type": "string" }, "raw_serverless_amount": { "type": "string" }, "raw_serverless_customer_success_amount": { "type": "string" }, "raw_serverless_program_credits_amount": { "type": "string" }, "raw_serverless_redeem_credits_amount": { "type": "string" }, "raw_starter_amount": { "type": "string" }, "raw_starter_customer_success_amount": { "type": "string" }, "raw_starter_program_credits_amount": { "type": "string" }, "raw_starter_redeem_credits_amount": { "type": "string" }, "raw_support_amount": { "type": "string" }, "raw_support_customer_success_amount": { "type": "string" }, "raw_support_program_credits_amount": { "type": "string" }, "raw_support_redeem_credits_amount": { "type": "string" }, "serverless_allocated_loss": { "type": "string" }, "serverless_amount": { "type": "string" }, "start_date": { "type": "string", "example": "2025-04-01" }, "starter_allocated_loss": { "type": "string" }, "starter_amount": { "type": "string" }, "stripe_amount": { "type": "array", "items": { "type": "string" } }, "stripe_amount_including_tax": { "type": "array", "items": { "type": "string" } }, "stripe_invoice": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_finalized_date": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_number": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid_date": { "type": "array", "items": { "type": "string" } }, "stripe_tax_rate": { "type": "array", "items": { "type": "string" } }, "support_accrual_amount": { "type": "string" }, "support_allocated_loss": { "type": "string" }, "support_amount": { "type": "string" }, "tenant_id": { "type": "string", "example": "100" }, "total_amount": { "type": "string", "example": "170.00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "wire_transfer_amount": { "type": "string", "example": "100.00" } } }, "forms.ARTableUpdateInput": { "type": "object", "required": [ "bill_month", "binded_billing_config_id", "payment_type", "tenant_id" ], "properties": { "bill_month": { "type": "string" }, "binded_billing_config_id": { "type": "string", "example": "0" }, "byoc_allocated_loss": { "type": "string" }, "channel_loss_amount": { "type": "string" }, "cppo_discountable_product_amount": { "type": "string" }, "cppo_non_discountable_product_amount": { "type": "string" }, "dedicated_accrual_amount": { "type": "string" }, "dedicated_allocated_loss": { "type": "string" }, "end_date": { "type": "string" }, "essential_allocated_loss": { "type": "string" }, "invoice_amount": { "type": "string" }, "is_estimated": { "type": "boolean" }, "lake_allocated_loss": { "type": "string" }, "marketplace_amount": { "type": "string" }, "partner_id": { "type": "string" }, "payment_code": { "type": "string" }, "payment_type": { "type": "string" }, "premium_allocated_loss": { "type": "string" }, "prepayment_credits": { "type": "string" }, "raw_byoc_amount": { "type": "string" }, "raw_byoc_customer_success_amount": { "type": "string" }, "raw_byoc_program_credits_amount": { "type": "string" }, "raw_byoc_redeem_credits_amount": { "type": "string" }, "raw_dedicated_amount": { "type": "string" }, "raw_dedicated_customer_success_amount": { "type": "string" }, "raw_dedicated_program_credits_amount": { "type": "string" }, "raw_dedicated_redeem_credits_amount": { "type": "string" }, "raw_essential_amount": { "type": "string" }, "raw_essential_customer_success_amount": { "type": "string" }, "raw_essential_program_credits_amount": { "type": "string" }, "raw_essential_redeem_credits_amount": { "type": "string" }, "raw_lake_amount": { "type": "string" }, "raw_lake_customer_success_amount": { "type": "string" }, "raw_lake_program_credits_amount": { "type": "string" }, "raw_lake_redeem_credits_amount": { "type": "string" }, "raw_premium_amount": { "type": "string" }, "raw_premium_customer_success_amount": { "type": "string" }, "raw_premium_program_credits_amount": { "type": "string" }, "raw_premium_redeem_credits_amount": { "type": "string" }, "raw_serverless_amount": { "type": "string" }, "raw_serverless_customer_success_amount": { "type": "string" }, "raw_serverless_program_credits_amount": { "type": "string" }, "raw_serverless_redeem_credits_amount": { "type": "string" }, "raw_starter_amount": { "type": "string" }, "raw_starter_customer_success_amount": { "type": "string" }, "raw_starter_program_credits_amount": { "type": "string" }, "raw_starter_redeem_credits_amount": { "type": "string" }, "raw_support_amount": { "type": "string" }, "raw_support_customer_success_amount": { "type": "string" }, "raw_support_program_credits_amount": { "type": "string" }, "raw_support_redeem_credits_amount": { "type": "string" }, "serverless_allocated_loss": { "type": "string" }, "start_date": { "type": "string" }, "starter_allocated_loss": { "type": "string" }, "stripe_amount": { "type": "array", "items": { "type": "string" } }, "stripe_amount_including_tax": { "type": "array", "items": { "type": "string" } }, "stripe_invoice": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_finalized_date": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_number": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid": { "type": "array", "items": { "type": "string" } }, "stripe_invoice_paid_date": { "type": "array", "items": { "type": "string" } }, "stripe_tax_rate": { "type": "array", "items": { "type": "string" } }, "support_accrual_amount": { "type": "string" }, "support_allocated_loss": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "total_amount": { "type": "string" }, "wire_transfer_amount": { "type": "string" } } }, "forms.Address": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" } } }, "forms.AliyunSubscriptionRecord": { "type": "object", "properties": { "ali_uid": { "type": "string" }, "biz_id": { "type": "string" }, "in_trial": { "type": "boolean" }, "is_subscribed": { "type": "boolean" }, "is_third_party": { "type": "boolean" }, "product_code": { "type": "string" } } }, "forms.AppAPIUsageExplore": { "type": "object", "properties": { "month": { "type": "integer" }, "network_usage": { "type": "integer" }, "request_count": { "type": "integer" }, "tenant_id": { "type": "integer" }, "usage_map": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } }, "forms.AuditLog": { "type": "object", "properties": { "action": { "type": "string" }, "created_at": { "type": "string" }, "email": { "type": "string" }, "is_cppo_customer": { "type": "boolean" }, "is_cppo_reseller": { "type": "boolean" }, "is_mcpo_customer": { "type": "boolean" }, "is_mcpo_reseller": { "type": "boolean" }, "is_msp": { "type": "boolean" }, "is_msp_customer": { "type": "boolean" }, "is_resale_customer": { "type": "boolean" }, "is_resale_partner": { "type": "boolean" }, "kind": { "type": "string" }, "name": { "type": "string" }, "operation_time": { "type": "string" }, "operator": { "$ref": "#/definitions/forms.User" }, "org_tag": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "third_party_account_provider": { "type": "string" }, "third_party_free_trial": { "type": "boolean" } } }, "forms.Beneficiary": { "type": "object", "properties": { "emailId": { "type": "string" }, "objectId": { "type": "string" }, "puid": { "type": "string" }, "tenantId": { "type": "string" } } }, "forms.BillingAction": { "type": "string", "enum": [ "add", "remove", "expand", "shrink", "view" ], "x-enum-varnames": [ "BillingAction_Create", "BillingAction_Delete", "BillingAction_Scaleup", "BillingAction_Scaledown", "BillingAction_View" ] }, "forms.BillingActionCheckBatchInput": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/definitions/forms.BillingActionInfo" } } } }, "forms.BillingActionCheckBatchOutput": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/forms.BillingActionCheckResult" } } } }, "forms.BillingActionCheckResult": { "type": "object", "properties": { "original": {}, "pass": { "type": "boolean" }, "reason": { "type": "string" } } }, "forms.BillingActionInfo": { "type": "object", "properties": { "action": { "$ref": "#/definitions/forms.BillingAction" }, "resource": { "$ref": "#/definitions/forms.BillingResource" } } }, "forms.BillingCompany": { "type": "object", "properties": { "company_key": { "type": "string" }, "name": { "type": "string" }, "payment_sub_code": { "type": "string" } } }, "forms.BillingConfig": { "type": "object", "properties": { "billing_config_id": { "type": "integer" }, "created_at": { "type": "string" }, "end_active_time": { "type": "string" }, "managed_tenant_id": { "type": "string", "example": "0" }, "start_active_time": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "type": { "type": "string" }, "updated_at": { "type": "string" } } }, "forms.BillingDetails": { "type": "object", "properties": { "address": { "$ref": "#/definitions/forms.Address" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" } } }, "forms.BillingInformation": { "type": "object", "properties": { "billing_email": { "type": "string" }, "city": { "type": "string" }, "company_name": { "type": "string" }, "country_code": { "description": "`X` stands `Others`", "type": "string" }, "custom_input_country_name": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_country_code": { "type": "string" }, "tax_id_type": { "type": "string" }, "tax_rate": { "$ref": "#/definitions/forms.TaxRate" }, "tax_vat": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.BillingInformationInput": { "type": "object", "properties": { "billing_email": { "type": "string" }, "city": { "type": "string" }, "company_name": { "type": "string" }, "country_code": { "description": "`X` stands `Others`", "type": "string" }, "custom_input_country_name": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" }, "tax_id_country_code": { "type": "string" }, "tax_id_type": { "type": "string" }, "tax_rate": { "$ref": "#/definitions/forms.TaxRate" }, "tax_vat": { "type": "string" } } }, "forms.BillingProfileForOpenAPI": { "type": "object", "properties": { "billingEmail": { "description": "The email address where invoices will be sent. This is only applicable for credit card payments.", "type": "string", "example": "example@tidbcloud.com" }, "city": { "description": "The full name of the city in the billing address.", "type": "string" }, "companyName": { "description": "The name of the company to be displayed on the invoice. This is only applicable for credit card payments.", "type": "string", "example": "PingCAP Inc." }, "countryCode": { "description": "A two-letter country code following the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard. For example, use \"US\" for the United States.", "type": "string", "example": "US" }, "line1": { "description": "The first line of the detailed billing address.", "type": "string" }, "line2": { "description": "The second line of the detailed billing address.", "type": "string" }, "postalCode": { "description": "The postal code of the billing address.", "type": "string", "example": "000000" }, "state": { "description": "The state or region code following the [ISO 3166-2 subdivision](https://en.wikipedia.org/wiki/ISO_3166-2) standard, without the country prefix. For example, use \"CA\" for California in the United States, not \"US-CA\".", "type": "string", "example": "CA" }, "taxId": { "description": "The tax ID of the billing entity. For more information, see [Supported Tax ID types](https://docs.stripe.com/billing/customer/tax-ids#supported-tax-id).", "type": "string" }, "taxIdType": { "description": "The type of tax ID provided. For more information, see [Supported Tax ID types](https://docs.stripe.com/billing/customer/tax-ids#supported-tax-id).", "allOf": [ { "$ref": "#/definitions/forms.TaxIDType" } ] } } }, "forms.BillingResource": { "type": "object", "properties": { "instance_id": { "type": "string" }, "is_free": { "type": "boolean" }, "origin": {}, "provider": { "$ref": "#/definitions/forms.ProviderEnum" }, "region": { "type": "string" }, "type": { "$ref": "#/definitions/forms.BillingResourceType" } } }, "forms.BillingResourceType": { "type": "string", "enum": [ "dedicated_cluster", "dedicated_backup", "lake_warehouse", "serverless_cluster", "essential_cluster", "premium_cluster", "starter_cluster" ], "x-enum-varnames": [ "BillingResourceType_DedicatedCluster", "BillingResourceType_DedicatedBackup", "BillingResourceType_LakeWarehouse", "BillingResourceType_ServerlessCluster", "BillingResourceType_EssentialCluster", "BillingResourceType_PremiumCluster", "BillingResourceType_StarterCluster" ] }, "forms.BillsCostExplorer": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/forms.BillsCostExplorerElements" } }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsCostExplorerBreakdown": { "type": "object", "properties": { "billedDate": { "type": "string" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "detailKey": { "type": "string" }, "detailName": { "type": "string" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsCostExplorerElements": { "type": "object", "properties": { "billedDate": { "type": "string" }, "breakdown": { "type": "array", "items": { "$ref": "#/definitions/forms.BillsCostExplorerBreakdown" } }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsDetail": { "type": "object", "properties": { "billedDate": { "description": "The date when this bill happens.", "type": "string" }, "clusterName": { "description": "Name of the cluster.", "type": "string" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "projectName": { "description": "Name of the project.", "type": "string" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "servicePathName": { "description": "Name of the service.", "type": "string" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsDetails": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/forms.BillsDetail" } } } }, "forms.BillsEnabled": { "type": "object", "properties": { "bills_enabled": { "type": "boolean" } } }, "forms.BillsExplorer": { "type": "object", "properties": { "overview": { "description": "The overall information for a bill in the specified organization.", "allOf": [ { "$ref": "#/definitions/forms.BillsOverview" } ] }, "summaryByProject": { "description": "A breakdown of the bill by project.", "allOf": [ { "$ref": "#/definitions/forms.SummaryByProject" } ] }, "summaryByService": { "description": "A breakdown of the bill by service.", "type": "array", "items": { "$ref": "#/definitions/forms.BillsServiceCosts" } } } }, "forms.BillsOtherName": { "type": "object", "properties": { "chargeName": { "type": "string", "example": "Support Plan" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsOverview": { "type": "object", "properties": { "billedMonth": { "description": "The month in which this bill is generated for the specified organization.", "type": "string", "example": "2023-09" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsProjects": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "projectName": { "description": "The name of a project in the specified organization.", "type": "string", "example": "prod-project" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BillsServiceCosts": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "serviceCosts": { "type": "array", "items": { "$ref": "#/definitions/forms.BillsServiceCosts" } }, "serviceName": { "description": "The name of services provided by TiDB Cloud.", "type": "string", "example": "TiDB Dedicated" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.BindedPackageInfo": { "type": "object", "properties": { "binded_billing_config_id": { "type": "integer" }, "binded_package_id": { "type": "integer" }, "closed_date": { "type": "string" }, "discount_enabled": { "type": "boolean" }, "expired_date": { "type": "string" }, "internal": { "type": "boolean" }, "invoice_payable": { "type": "boolean" }, "package_id": { "type": "integer" }, "remaining_credits": { "type": "string" }, "started_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "unit_filters": { "description": "PackageInfo *PackageInfo `json:\"package_info\"`", "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilter" } } } }, "forms.BindedPackageInfoInput": { "type": "object", "properties": { "binded_billing_config_id": { "type": "integer" }, "package_id": { "type": "integer" } } }, "forms.BindedSupportPlan": { "type": "object", "properties": { "active_date": { "type": "string" }, "binded_support_plan_id": { "type": "integer" }, "closed_date": { "type": "string" }, "expired_date": { "type": "string" }, "fixed_charge_price": { "type": "string" }, "is_eligible_for_free_trial": { "type": "boolean" }, "is_in_free_trial": { "type": "boolean" }, "is_support_free_trial": { "type": "boolean" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "rest_days_of_free_trial": { "type": "integer" }, "status": { "type": "string" }, "support_plan_id": { "type": "integer" }, "support_price_percentage": { "type": "string" }, "tenant_id": { "type": "integer" }, "tiered_price_rules": { "type": "array", "items": { "$ref": "#/definitions/forms.TieredPriceRule" } }, "type": { "type": "string" } } }, "forms.BindedSupportPlanDetails": { "type": "object", "properties": { "binded_support_plans": { "type": "array", "items": { "$ref": "#/definitions/forms.BindedSupportPlan" } }, "is_eligible_for_free_trial": { "type": "boolean" } } }, "forms.Budget": { "type": "object", "properties": { "biz_data": { "type": "string" }, "biz_type": { "type": "string" }, "cost_type": { "type": "string" }, "costs": { "type": "string" }, "has_serverless_free_credits": { "type": "boolean" }, "interval": { "type": "string" }, "limit": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "range_id": { "type": "integer" }, "range_id_str": { "type": "string", "example": "0" }, "range_type": { "type": "string" }, "spendlimit_setting_id": { "type": "integer" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "thresholds": { "type": "array", "items": { "$ref": "#/definitions/forms.SpendLimitThreshold" } } } }, "forms.BudgetCostType": { "type": "string", "enum": [ "total", "invoice" ], "x-enum-varnames": [ "BudgetCostType_Total", "BudgetCostType_Invoice" ] }, "forms.BudgetForOpenAPI": { "type": "object", "properties": { "applyCredits": { "description": "Indicates whether to deduct credits when calculating cost. Only applicable when `costType` is set to `\"total\"`.", "type": "boolean" }, "applyDiscounts": { "description": "Indicates whether to deduct discounts when calculating cost. Only applicable when `costType` is set to `\"total\"`.", "type": "boolean" }, "bizType": { "description": "The business type of the budget. Note: You can only create `\"budget_alert\"` type budgets using the API.", "type": "string" }, "budgetId": { "description": "A unique identifier for the budget.", "type": "string", "example": "0" }, "budgetInterval": { "description": "The interval for which the budget applies.", "allOf": [ { "$ref": "#/definitions/forms.BudgetInterval" } ] }, "cost": { "description": "The current cost accrued against this budget.", "type": "string" }, "costType": { "description": "The type of the budget cost.\n- `\"total\"`: the total cost\n- `\"invoice\"`: the bills you need pay", "allOf": [ { "$ref": "#/definitions/forms.BudgetCostType" } ] }, "enableEmailNotification": { "description": "Indicates whether email notifications are enabled when the budget threshold is reached.", "type": "boolean" }, "limit": { "description": "The maximum amount set for this budget.", "type": "string" }, "name": { "description": "The name of the budget.", "type": "string" }, "rangId": { "description": "The ID of the entity to which this budget applies.", "type": "string", "example": "0" }, "rangeType": { "description": "The type of entity to which this budget applies. You can specify an organization (tenant), a project, or a customer (only for partners). You cannot specify a cluster.", "allOf": [ { "$ref": "#/definitions/forms.BudgetRangeType" } ] }, "thresholds": { "description": "An array of threshold values for this budget. Must contain at least one and up to five thresholds.", "type": "array", "items": { "$ref": "#/definitions/forms.BudgetThreshold" } } } }, "forms.BudgetInterval": { "type": "string", "enum": [ "monthly" ], "x-enum-varnames": [ "BudgetInterval_Monthly" ] }, "forms.BudgetRangeType": { "type": "string", "enum": [ "tenant", "project", "cluster", "customer" ], "x-enum-varnames": [ "BudgetRangeType_Tenant", "BudgetRangeType_Project", "BudgetRangeType_Cluster", "BudgetRangeType_Customer" ] }, "forms.BudgetThreshold": { "type": "object", "properties": { "proportion": { "description": "The budget threshold as a decimal value. For example, `\"0.3\"` means that when the cost reaches 30% of the limit, the specified action (such as email notification) will be triggered.", "type": "string", "example": "0.3" } } }, "forms.CPPOBillingConfig": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } }, "effective_date": { "type": "string" }, "payment_code": { "type": "string" }, "payment_sub_code": { "type": "string" }, "reseller_id": { "type": "string", "example": "0" }, "support_plan": { "$ref": "#/definitions/forms.SupportPlanInput" }, "tenant_id": { "type": "string", "example": "0" } } }, "forms.CampaignListResponse": { "type": "object", "properties": { "campaigns": { "type": "array", "items": { "$ref": "#/definitions/forms.CampaignResponse" } }, "remaining_all": { "type": "string" }, "total_budget_all": { "type": "string" }, "used_budget_all": { "type": "string" } } }, "forms.CampaignResponse": { "type": "object", "properties": { "created_at": { "type": "string" }, "created_by": { "type": "string" }, "id": { "type": "integer" }, "is_website_campaign": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "remaining_budget": { "type": "string" }, "status": { "type": "string" }, "total_budget": { "type": "string" }, "used_budget": { "type": "string" } } }, "forms.Card": { "type": "object", "properties": { "brand": { "type": "string" }, "country": { "type": "string" }, "exp_month": { "type": "string", "example": "0" }, "exp_year": { "type": "string", "example": "0" }, "fingerprint": { "type": "string" }, "funding": { "type": "string" }, "last4": { "type": "string" } } }, "forms.CardValidateResult": { "type": "object", "properties": { "client_secret": { "type": "string" }, "payment_intent_id": { "type": "string" }, "public_key": { "type": "string" }, "status": { "type": "string" } } }, "forms.CategoryCosts": { "type": "object", "properties": { "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "order": { "type": "integer" }, "raw_price": { "type": "string" }, "service_plan": { "type": "string" }, "unit_costs": { "description": "unused?", "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.CategoryItemCosts": { "type": "object", "properties": { "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "order": { "type": "integer" }, "raw_price": { "type": "string" }, "unit_costs": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.CategoryItemShow": { "type": "object", "properties": { "category": { "type": "string" }, "commodity_code": { "type": "string" }, "edition_code": { "type": "string" }, "label_key": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "measure_unit": { "type": "string" }, "order_map": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "parent_key": { "type": "string" }, "show_category_name": { "type": "string" }, "show_kind_name": { "type": "string" }, "show_service_prefix": { "type": "string" }, "use_cate_gory": { "type": "boolean" } } }, "forms.CategoryNode": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/definitions/forms.CategoryNode" } }, "key": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" }, "parent_key": { "type": "string" } } }, "forms.CloseAction": { "type": "object", "properties": { "action": { "type": "string" }, "action_time_in_hour": { "type": "integer" } } }, "forms.CloseActionStatusInner": { "type": "object", "additionalProperties": { "type": "string" } }, "forms.CloseActionsStatus": { "type": "object", "properties": { "status": { "$ref": "#/definitions/forms.CloseActionStatusInner" } } }, "forms.ClosePolicy": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/definitions/forms.CloseAction" } }, "cancel_action": { "$ref": "#/definitions/forms.CloseAction" } } }, "forms.Cluster": { "type": "object", "properties": { "cloud_provider_name": { "type": "string" }, "deploy_type": { "type": "integer" }, "id": { "type": "string", "example": "0" }, "infra_provider_type": { "type": "string" }, "is_dev_tier": { "type": "boolean" }, "name": { "type": "string" }, "project_id": { "type": "string", "example": "0" }, "region_display_name": { "type": "string" }, "region_name": { "type": "string" }, "service_plan": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" } } }, "forms.ClusterOpenAPI": { "type": "object", "properties": { "ProjectID": { "type": "string", "example": "0" }, "id": { "type": "string", "example": "0" }, "name": { "type": "string" }, "regionName": { "type": "string" }, "status": { "type": "string" } } }, "forms.CommitmentInvoiceInput": { "type": "object", "properties": { "amount": { "type": "string" }, "binded_billing_config_id": { "type": "integer" }, "owner": { "type": "string" }, "payment_code": { "type": "string" }, "time": { "type": "string" } } }, "forms.Commodity": { "type": "object", "properties": { "ID": { "type": "integer" }, "commodity_code": { "type": "string" }, "commodity_show_name": { "type": "string" }, "commodity_type": { "type": "string" }, "created_at": { "type": "string" }, "modifier_info": { "$ref": "#/definitions/forms.ModifierAndCreator" }, "owner": { "type": "string" }, "updated_at": { "type": "string" } } }, "forms.CommodityDimension": { "type": "object", "properties": { "ID": { "type": "integer" }, "commodity_code": { "description": "optional", "type": "string" }, "created_at": { "type": "string" }, "dimension_code": { "type": "string" }, "dimension_show_name": { "type": "string" }, "dimension_value": { "$ref": "#/definitions/forms.DimensionValue" }, "is_charge": { "type": "boolean" }, "is_share": { "type": "boolean" }, "modifier_info": { "$ref": "#/definitions/forms.ModifierAndCreator" }, "updated_at": { "type": "string" } } }, "forms.CommodityDimensionModify": { "type": "object", "properties": { "commodity_dimension": { "$ref": "#/definitions/forms.CommodityDimension" }, "modifyID": { "type": "integer" } } }, "forms.CommodityDimensionQuery": { "type": "object", "properties": { "commodity_code": { "description": "optional", "type": "string" }, "dimension_code": { "description": "optional", "type": "string" }, "dimension_show_name": { "description": "optional", "type": "string" }, "query_type": { "description": "optional", "type": "string" } } }, "forms.CommodityEdition": { "type": "object", "properties": { "ID": { "type": "integer" }, "commodity_code": { "type": "string" }, "created_at": { "type": "string" }, "edition_code": { "type": "string" }, "edition_dimension_value": { "$ref": "#/definitions/forms.EditionDimensionValue" }, "edition_show_name": { "type": "string" }, "modifier_info": { "$ref": "#/definitions/forms.ModifierAndCreator" }, "updated_at": { "type": "string" } } }, "forms.CommodityEditionModify": { "type": "object", "properties": { "commodity_edition": { "$ref": "#/definitions/forms.CommodityEdition" }, "modifyID": { "type": "integer" } } }, "forms.CommodityEditionQuery": { "type": "object", "properties": { "commodity_code": { "description": "optional", "type": "string" }, "edition_code": { "description": "optional", "type": "string" }, "edition_show_name": { "description": "optional", "type": "string" }, "query_type": { "description": "optional", "type": "string" } } }, "forms.CommodityModify": { "type": "object", "properties": { "commodity": { "$ref": "#/definitions/forms.Commodity" }, "modifyID": { "type": "integer" } } }, "forms.CommodityQuery": { "type": "object", "properties": { "commodity_code": { "description": "optional", "type": "string" }, "commodity_show_name": { "description": "optional", "type": "string" }, "owner": { "description": "optional", "type": "string" }, "query_type": { "description": "optional", "type": "string" } } }, "forms.Contract": { "type": "object", "properties": { "contact_email": { "type": "string" }, "contract_id": { "type": "string" }, "contract_type": { "type": "string" }, "created_at": { "type": "string" }, "file_path": { "type": "string" }, "id": { "type": "integer" }, "last_operator_id": { "type": "integer" }, "operated_at": { "type": "string" }, "reason_for_last_operation": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.ContractInput": { "type": "object", "required": [ "contact_email", "file_path" ], "properties": { "contact_email": { "type": "string" }, "contract_id": { "type": "string" }, "contract_type": { "type": "string" }, "file_path": { "type": "string" } } }, "forms.ContractsResponse": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/definitions/forms.Contract" } }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_results": { "type": "integer" } } }, "forms.CostExploreTrendsInput": { "type": "object", "properties": { "breakdown_by": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerTrendsBreakdownKey" } }, "clusters": { "type": "array", "items": { "type": "string" } }, "consumed_source": { "type": "string" }, "customers": { "type": "array", "items": { "type": "string" } }, "end_date": { "type": "string" }, "ignore_beta": { "type": "boolean" }, "invoices": { "type": "array", "items": { "type": "string" } }, "projects": { "type": "array", "items": { "type": "string" } }, "providers": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerProvider" } }, "services": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } }, "start_date": { "type": "string" }, "time_group": { "$ref": "#/definitions/forms.CostExplorerTrendsTimeGroup" } } }, "forms.CostExploreTrendsOutput": { "type": "object", "properties": { "cost_price": { "type": "string" }, "credits_usage": { "type": "string" }, "discount": { "type": "string" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExploreTrendsOutputElement" } }, "raw_price": { "type": "string" } } }, "forms.CostExploreTrendsOutputBreakdownDetail": { "type": "object", "properties": { "billing_date": { "type": "string" }, "category": { "description": "The service category name (second level).", "type": "string" }, "cluster_id": { "type": "string", "example": "0" }, "cluster_name": { "type": "string" }, "component": { "description": "The service component name (third level).", "type": "string" }, "cost_price": { "type": "string" }, "credits_usage": { "type": "string" }, "customer_id": { "type": "string" }, "customer_name": { "type": "string" }, "detail_key": { "type": "string" }, "detail_name": { "type": "string" }, "discount": { "type": "string" }, "product": { "description": "The service product name (first level).", "type": "string" }, "project_id": { "type": "string", "example": "0" }, "project_name": { "type": "string" }, "provider": { "type": "string" }, "raw_price": { "type": "string" }, "region": { "type": "string" }, "service": { "description": "The full service name, typically combining all levels.", "type": "string" } } }, "forms.CostExploreTrendsOutputElement": { "type": "object", "properties": { "billing_date": { "type": "string" }, "breakdown": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExploreTrendsOutputBreakdownDetail" } }, "cost_price": { "type": "string" }, "credits_usage": { "type": "string" }, "discount": { "type": "string" }, "prediction": { "type": "boolean" }, "raw_price": { "type": "string" } } }, "forms.CostExplorerArgs": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/forms.Cluster" } }, "products": { "type": "array", "items": { "type": "string" } }, "projects": { "type": "array", "items": { "$ref": "#/definitions/forms.Project" } }, "providers": { "type": "array", "items": { "$ref": "#/definitions/forms.Provider" } }, "services": { "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } } } }, "forms.CostExplorerDetailsResult": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/forms.UsageDetails" } } } }, "forms.CostExplorerInternalQuery": { "type": "object", "properties": { "end_date": { "type": "string" }, "ignore_beta": { "type": "boolean" }, "internal": { "type": "boolean" }, "invoice_id": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "start_date": { "type": "string" }, "units": { "type": "array", "items": { "type": "string" } } } }, "forms.CostExplorerOpenCostsMeta": { "type": "object", "properties": { "billing_config_id": { "type": "string", "example": "0" }, "fact_count": { "type": "integer" }, "input_bundle_id": { "type": "string", "example": "0" }, "invoice_fact_count": { "type": "integer" }, "legacy_row_count": { "type": "integer" }, "matched_credit_items": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsPackage" } }, "matched_credit_package_ids": { "type": "string" }, "matched_credits": { "type": "string" }, "matched_discount_ids": { "type": "string" }, "matched_discount_items": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } }, "matched_discounts": { "type": "string" }, "period_month": { "type": "string" }, "source_mode": { "type": "string" }, "source_run_id": { "type": "string", "example": "0" }, "tenant_id": { "type": "string", "example": "0" }, "window_end": { "type": "string" }, "window_start": { "type": "string" } } }, "forms.CostExplorerOpenCostsResponse": { "type": "object", "properties": { "billsDetails": { "$ref": "#/definitions/forms.CostExplorerDetailsResult" }, "meta": { "$ref": "#/definitions/forms.CostExplorerOpenCostsMeta" }, "overview": { "description": "The overall information for a bill in the specified organization.", "allOf": [ { "$ref": "#/definitions/forms.OpenCostsBillsOverview" } ] }, "summaryByProject": { "description": "A breakdown of the bill by project.", "allOf": [ { "$ref": "#/definitions/forms.OpenCostsSummaryByProject" } ] }, "summaryByService": { "description": "A breakdown of the bill by service.", "type": "array", "items": { "$ref": "#/definitions/forms.OpenCostsBillsServiceCosts" } } } }, "forms.CostExplorerProvider": { "type": "object", "properties": { "name": { "description": "The name of the cloud provider to include in the query.", "type": "string" }, "regions": { "description": "A list of region names to include in the query.", "type": "array", "items": { "type": "string" } } } }, "forms.CostExplorerQuery": { "type": "object", "properties": { "end_date": { "type": "string" }, "invoice_id": { "type": "integer" }, "start_date": { "type": "string" } } }, "forms.CostExplorerQueryV2": { "type": "object", "properties": { "binded_package_ids": { "type": "array", "items": { "type": "integer" } }, "end_date": { "type": "string" }, "ignore_beta": { "type": "boolean" }, "ignore_invoice_id": { "type": "boolean" }, "invoice_id": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "start_date": { "type": "string" }, "units": { "type": "array", "items": { "type": "string" } } } }, "forms.CostExplorerResult": { "type": "object", "properties": { "binded_invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "credits_costs": { "$ref": "#/definitions/forms.Costs" }, "invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "total_costs": { "$ref": "#/definitions/forms.Costs" }, "unbind_invoice_costs": { "$ref": "#/definitions/forms.Costs" } } }, "forms.CostExplorerService": { "type": "object", "properties": { "category": { "description": "The service category name (second level).", "type": "string" }, "component": { "description": "The service component name (third level).", "type": "string" }, "product": { "description": "The service product name (first level).", "type": "string" }, "service": { "description": "The full service name, typically combining all levels.", "type": "string" } } }, "forms.CostExplorerTrendsBreakdownKey": { "type": "string", "enum": [ "service", "product", "project", "cluster", "provider", "region", "customer" ], "x-enum-varnames": [ "CostExploreTrendsBreakdownKeyService", "CostExploreTrendsBreakdownKeyProduct", "CostExploreTrendsBreakdownKeyProject", "CostExploreTrendsBreakdownKeyCluster", "CostExploreTrendsBreakdownKeyProvider", "CostExploreTrendsBreakdownKeyRegion", "CostExploreTrendsBreakdownKeyCustomer" ] }, "forms.CostExplorerTrendsTimeGroup": { "type": "string", "enum": [ "day", "month", "total" ], "x-enum-varnames": [ "CostExploreTrendsTimeGroupDay", "CostExploreTrendsTimeGroupMonth", "CostExploreTrendsTimeGroupTotal" ] }, "forms.CostQuota": { "type": "object", "properties": { "cost_quota_limit": { "type": "string" } } }, "forms.Costs": { "type": "object", "properties": { "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "category_use_item": { "type": "boolean" }, "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "kind_category_units_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryItemCosts" } }, "label_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.LabelCosts" } }, "order": { "type": "integer" }, "raw_price": { "type": "string" }, "service_plan": { "type": "string" }, "unit_costs": { "description": "unused?", "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.CreateCampaignReq": { "type": "object", "required": [ "name", "total_budget" ], "properties": { "is_website_campaign": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "total_budget": { "type": "string" } } }, "forms.CreateCreditsPackageReq": { "type": "object", "properties": { "bind_types": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "clusters": { "type": "array", "items": { "type": "string" } }, "customers": { "type": "array", "items": { "type": "string" } }, "discount_enabled": { "type": "boolean" }, "expired_date": { "type": "string" }, "foreign_id": { "type": "string" }, "note": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "provider": { "$ref": "#/definitions/forms.ProviderEnum" }, "start_date": { "type": "string" }, "total_credits": { "type": "string" }, "type": { "type": "string" }, "unit_filters": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "usage": { "type": "string" }, "usage_extend": { "type": "string" }, "user_email": { "type": "string" } } }, "forms.CreateInvoiceReq": { "type": "object", "properties": { "start_date": { "type": "string" }, "type": { "type": "string" } } }, "forms.CreditRiskLevel": { "type": "object", "properties": { "cost_quota": { "$ref": "#/definitions/forms.CostQuota" }, "credit_risk_level_id": { "type": "integer" }, "credit_risk_level_name": { "type": "string" } } }, "forms.CreditRiskLevelIDInput": { "type": "object", "properties": { "credit_risk_level_id": { "type": "integer" } } }, "forms.CreditRiskLevelInput": { "type": "object", "properties": { "credit_risk_level_name": { "type": "string" } } }, "forms.CreditsChargeHistory": { "type": "object", "properties": { "binded_package_id": { "type": "integer" }, "history": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsChargeInfo" } }, "total_amounts": { "type": "string" } } }, "forms.CreditsChargeInfo": { "type": "object", "properties": { "binded_package_id": { "type": "integer" }, "charge_count": { "type": "string" }, "charge_reason": { "type": "string" }, "charge_time": { "type": "string" }, "charger_tenant_id": { "type": "integer" }, "charger_user_id": { "type": "integer" } } }, "forms.CreditsChargeInfoInput": { "type": "object", "properties": { "charge_count": { "type": "string" }, "charge_reason": { "type": "string" }, "charger_tenant_id": { "type": "integer" }, "charger_user_id": { "type": "integer" } } }, "forms.CreditsForOpenAPI": { "type": "object", "properties": { "credit": { "description": "The total amount of credit.", "type": "string", "example": "1000.00" }, "creditCode": { "description": "A unique identifier for the credit.", "type": "string", "example": "498c7f44-656f-4944-b455-0695faa5d4f9" }, "customers": { "description": "The credits can only apply on the costs from the specific customers, `empty` means no restrictions", "type": "array", "items": { "type": "string" } }, "expiryDate": { "description": "The expiration date of the credit. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-11-01T00:00:00Z\"`.", "type": "string", "example": "2023-12-01T00:00:00Z" }, "provider": { "description": "The credits can only apply on the costs from the specific provider, `all` means no restrictions", "allOf": [ { "$ref": "#/definitions/forms.ProviderEnum" } ], "example": "all" }, "remainingCredit": { "description": "The remaining amount of the credit.", "type": "string", "example": "1000.00" }, "services": { "description": "The service to which the credit is applicable.", "type": "string", "example": "General Product" }, "startDate": { "description": "The effective start date of the credit. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-11-01T00:00:00Z\"`.", "type": "string", "example": "2023-11-01T00:00:00Z" }, "status": { "description": "The current status of the credit.", "allOf": [ { "$ref": "#/definitions/forms.CreditsState" } ], "example": "active" } } }, "forms.CreditsPackage": { "type": "object", "properties": { "bind_types": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "binded_billing_config_id": { "type": "integer" }, "binded_package_id": { "type": "integer" }, "closed_date": { "type": "string" }, "closed_reason": { "type": "string" }, "clusters": { "type": "array", "items": { "type": "string" } }, "credits_code": { "type": "string" }, "credits_package_id": { "type": "integer" }, "customers": { "type": "array", "items": { "type": "string" } }, "discount_enabled": { "type": "boolean" }, "expired_date": { "type": "string" }, "foreign_id": { "type": "string" }, "internal": { "type": "boolean" }, "note": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "provider": { "$ref": "#/definitions/forms.ProviderEnum" }, "remaining_credits": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "total_credits": { "type": "string" }, "type": { "type": "string" }, "unit_filters": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "usage": { "type": "string" }, "usage_extend": { "type": "string" }, "user_email": { "type": "string" } } }, "forms.CreditsState": { "type": "string", "enum": [ "active", "inactive", "before_active" ], "x-enum-varnames": [ "CreditsState_Active", "CreditsState_Inactive", "CreditsState_BeforeActive" ] }, "forms.CreditsSummary": { "type": "object", "properties": { "active_credits_packages_count": { "type": "integer" }, "active_poc_credits_packages_count": { "type": "integer" }, "available_costed_credits": { "type": "string" }, "available_costed_poc_credits": { "type": "string" }, "available_credits": { "type": "string" }, "available_poc_credits": { "type": "string" }, "available_remaining_credits": { "type": "string" }, "available_remaining_poc_credits": { "type": "string" }, "last_credits_closed_date": { "type": "string" }, "tenant_id": { "type": "integer" }, "total_costed_credits": { "type": "string" }, "total_credits": { "type": "string" } } }, "forms.Currency": { "type": "string", "enum": [ "aed", "afn", "all", "amd", "ang", "aoa", "ars", "aud", "awg", "azn", "bam", "bbd", "bdt", "bgn", "bif", "bmd", "bnd", "bob", "brl", "bsd", "bwp", "bzd", "cad", "cdf", "chf", "clp", "cny", "cop", "crc", "cve", "czk", "djf", "dkk", "dop", "dzd", "eek", "egp", "etb", "eur", "fjd", "fkp", "gbp", "gel", "gip", "gmd", "gnf", "gtq", "gyd", "hkd", "hnl", "hrk", "htg", "huf", "idr", "ils", "inr", "isk", "jmd", "jpy", "kes", "kgs", "khr", "kmf", "krw", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "ltl", "lvl", "mad", "mdl", "mga", "mkd", "mnt", "mop", "mro", "mur", "mvr", "mwk", "mxn", "myr", "mzn", "nad", "ngn", "nio", "nok", "npr", "nzd", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rsd", "rub", "rwf", "sar", "sbd", "scr", "sek", "sgd", "shp", "sll", "sos", "srd", "std", "svc", "szl", "thb", "tjs", "top", "try", "ttd", "twd", "tzs", "uah", "ugx", "usd", "uyu", "uzs", "vef", "vnd", "vuv", "wst", "xaf", "xcd", "xof", "xpf", "yer", "zar", "zmw" ], "x-enum-comments": { "CurrencyAED": "United Arab Emirates Dirham", "CurrencyAFN": "Afghan Afghani", "CurrencyALL": "Albanian Lek", "CurrencyAMD": "Armenian Dram", "CurrencyANG": "Netherlands Antillean Gulden", "CurrencyAOA": "Angolan Kwanza", "CurrencyARS": "Argentine Peso", "CurrencyAUD": "Australian Dollar", "CurrencyAWG": "Aruban Florin", "CurrencyAZN": "Azerbaijani Manat", "CurrencyBAM": "Bosnia \u0026 Herzegovina Convertible Mark", "CurrencyBBD": "Barbadian Dollar", "CurrencyBDT": "Bangladeshi Taka", "CurrencyBGN": "Bulgarian Lev", "CurrencyBIF": "Burundian Franc", "CurrencyBMD": "Bermudian Dollar", "CurrencyBND": "Brunei Dollar", "CurrencyBOB": "Bolivian Boliviano", "CurrencyBRL": "Brazilian Real", "CurrencyBSD": "Bahamian Dollar", "CurrencyBWP": "Botswana Pula", "CurrencyBZD": "Belize Dollar", "CurrencyCAD": "Canadian Dollar", "CurrencyCDF": "Congolese Franc", "CurrencyCHF": "Swiss Franc", "CurrencyCLP": "Chilean Peso", "CurrencyCNY": "Chinese Renminbi Yuan", "CurrencyCOP": "Colombian Peso", "CurrencyCRC": "Costa Rican Colón", "CurrencyCVE": "Cape Verdean Escudo", "CurrencyCZK": "Czech Koruna", "CurrencyDJF": "Djiboutian Franc", "CurrencyDKK": "Danish Krone", "CurrencyDOP": "Dominican Peso", "CurrencyDZD": "Algerian Dinar", "CurrencyEEK": "Estonian Kroon", "CurrencyEGP": "Egyptian Pound", "CurrencyETB": "Ethiopian Birr", "CurrencyEUR": "Euro", "CurrencyFJD": "Fijian Dollar", "CurrencyFKP": "Falkland Islands Pound", "CurrencyGBP": "British Pound", "CurrencyGEL": "Georgian Lari", "CurrencyGIP": "Gibraltar Pound", "CurrencyGMD": "Gambian Dalasi", "CurrencyGNF": "Guinean Franc", "CurrencyGTQ": "Guatemalan Quetzal", "CurrencyGYD": "Guyanese Dollar", "CurrencyHKD": "Hong Kong Dollar", "CurrencyHNL": "Honduran Lempira", "CurrencyHRK": "Croatian Kuna", "CurrencyHTG": "Haitian Gourde", "CurrencyHUF": "Hungarian Forint", "CurrencyIDR": "Indonesian Rupiah", "CurrencyILS": "Israeli New Sheqel", "CurrencyINR": "Indian Rupee", "CurrencyISK": "Icelandic Króna", "CurrencyJMD": "Jamaican Dollar", "CurrencyJPY": "Japanese Yen", "CurrencyKES": "Kenyan Shilling", "CurrencyKGS": "Kyrgyzstani Som", "CurrencyKHR": "Cambodian Riel", "CurrencyKMF": "Comorian Franc", "CurrencyKRW": "South Korean Won", "CurrencyKYD": "Cayman Islands Dollar", "CurrencyKZT": "Kazakhstani Tenge", "CurrencyLAK": "Lao Kip", "CurrencyLBP": "Lebanese Pound", "CurrencyLKR": "Sri Lankan Rupee", "CurrencyLRD": "Liberian Dollar", "CurrencyLSL": "Lesotho Loti", "CurrencyLTL": "Lithuanian Litas", "CurrencyLVL": "Latvian Lats", "CurrencyMAD": "Moroccan Dirham", "CurrencyMDL": "Moldovan Leu", "CurrencyMGA": "Malagasy Ariary", "CurrencyMKD": "Macedonian Denar", "CurrencyMNT": "Mongolian Tögrög", "CurrencyMOP": "Macanese Pataca", "CurrencyMRO": "Mauritanian Ouguiya", "CurrencyMUR": "Mauritian Rupee", "CurrencyMVR": "Maldivian Rufiyaa", "CurrencyMWK": "Malawian Kwacha", "CurrencyMXN": "Mexican Peso", "CurrencyMYR": "Malaysian Ringgit", "CurrencyMZN": "Mozambican Metical", "CurrencyNAD": "Namibian Dollar", "CurrencyNGN": "Nigerian Naira", "CurrencyNIO": "Nicaraguan Córdoba", "CurrencyNOK": "Norwegian Krone", "CurrencyNPR": "Nepalese Rupee", "CurrencyNZD": "New Zealand Dollar", "CurrencyPAB": "Panamanian Balboa", "CurrencyPEN": "Peruvian Nuevo Sol", "CurrencyPGK": "Papua New Guinean Kina", "CurrencyPHP": "Philippine Peso", "CurrencyPKR": "Pakistani Rupee", "CurrencyPLN": "Polish Złoty", "CurrencyPYG": "Paraguayan Guaraní", "CurrencyQAR": "Qatari Riyal", "CurrencyRON": "Romanian Leu", "CurrencyRSD": "Serbian Dinar", "CurrencyRUB": "Russian Ruble", "CurrencyRWF": "Rwandan Franc", "CurrencySAR": "Saudi Riyal", "CurrencySBD": "Solomon Islands Dollar", "CurrencySCR": "Seychellois Rupee", "CurrencySEK": "Swedish Krona", "CurrencySGD": "Singapore Dollar", "CurrencySHP": "Saint Helenian Pound", "CurrencySLL": "Sierra Leonean Leone", "CurrencySOS": "Somali Shilling", "CurrencySRD": "Surinamese Dollar", "CurrencySTD": "São Tomé and Príncipe Dobra", "CurrencySVC": "Salvadoran Colón", "CurrencySZL": "Swazi Lilangeni", "CurrencyTHB": "Thai Baht", "CurrencyTJS": "Tajikistani Somoni", "CurrencyTOP": "Tongan Paʻanga", "CurrencyTRY": "Turkish Lira", "CurrencyTTD": "Trinidad and Tobago Dollar", "CurrencyTWD": "New Taiwan Dollar", "CurrencyTZS": "Tanzanian Shilling", "CurrencyUAH": "Ukrainian Hryvnia", "CurrencyUGX": "Ugandan Shilling", "CurrencyUSD": "United States Dollar", "CurrencyUYU": "Uruguayan Peso", "CurrencyUZS": "Uzbekistani Som", "CurrencyVEF": "Venezuelan Bolívar", "CurrencyVND": "Vietnamese Đồng", "CurrencyVUV": "Vanuatu Vatu", "CurrencyWST": "Samoan Tala", "CurrencyXAF": "Central African Cfa Franc", "CurrencyXCD": "East Caribbean Dollar", "CurrencyXOF": "West African Cfa Franc", "CurrencyXPF": "Cfp Franc", "CurrencyYER": "Yemeni Rial", "CurrencyZAR": "South African Rand", "CurrencyZMW": "Zambian Kwacha" }, "x-enum-descriptions": [ "United Arab Emirates Dirham", "Afghan Afghani", "Albanian Lek", "Armenian Dram", "Netherlands Antillean Gulden", "Angolan Kwanza", "Argentine Peso", "Australian Dollar", "Aruban Florin", "Azerbaijani Manat", "Bosnia \u0026 Herzegovina Convertible Mark", "Barbadian Dollar", "Bangladeshi Taka", "Bulgarian Lev", "Burundian Franc", "Bermudian Dollar", "Brunei Dollar", "Bolivian Boliviano", "Brazilian Real", "Bahamian Dollar", "Botswana Pula", "Belize Dollar", "Canadian Dollar", "Congolese Franc", "Swiss Franc", "Chilean Peso", "Chinese Renminbi Yuan", "Colombian Peso", "Costa Rican Colón", "Cape Verdean Escudo", "Czech Koruna", "Djiboutian Franc", "Danish Krone", "Dominican Peso", "Algerian Dinar", "Estonian Kroon", "Egyptian Pound", "Ethiopian Birr", "Euro", "Fijian Dollar", "Falkland Islands Pound", "British Pound", "Georgian Lari", "Gibraltar Pound", "Gambian Dalasi", "Guinean Franc", "Guatemalan Quetzal", "Guyanese Dollar", "Hong Kong Dollar", "Honduran Lempira", "Croatian Kuna", "Haitian Gourde", "Hungarian Forint", "Indonesian Rupiah", "Israeli New Sheqel", "Indian Rupee", "Icelandic Króna", "Jamaican Dollar", "Japanese Yen", "Kenyan Shilling", "Kyrgyzstani Som", "Cambodian Riel", "Comorian Franc", "South Korean Won", "Cayman Islands Dollar", "Kazakhstani Tenge", "Lao Kip", "Lebanese Pound", "Sri Lankan Rupee", "Liberian Dollar", "Lesotho Loti", "Lithuanian Litas", "Latvian Lats", "Moroccan Dirham", "Moldovan Leu", "Malagasy Ariary", "Macedonian Denar", "Mongolian Tögrög", "Macanese Pataca", "Mauritanian Ouguiya", "Mauritian Rupee", "Maldivian Rufiyaa", "Malawian Kwacha", "Mexican Peso", "Malaysian Ringgit", "Mozambican Metical", "Namibian Dollar", "Nigerian Naira", "Nicaraguan Córdoba", "Norwegian Krone", "Nepalese Rupee", "New Zealand Dollar", "Panamanian Balboa", "Peruvian Nuevo Sol", "Papua New Guinean Kina", "Philippine Peso", "Pakistani Rupee", "Polish Złoty", "Paraguayan Guaraní", "Qatari Riyal", "Romanian Leu", "Serbian Dinar", "Russian Ruble", "Rwandan Franc", "Saudi Riyal", "Solomon Islands Dollar", "Seychellois Rupee", "Swedish Krona", "Singapore Dollar", "Saint Helenian Pound", "Sierra Leonean Leone", "Somali Shilling", "Surinamese Dollar", "São Tomé and Príncipe Dobra", "Salvadoran Colón", "Swazi Lilangeni", "Thai Baht", "Tajikistani Somoni", "Tongan Paʻanga", "Turkish Lira", "Trinidad and Tobago Dollar", "New Taiwan Dollar", "Tanzanian Shilling", "Ukrainian Hryvnia", "Ugandan Shilling", "United States Dollar", "Uruguayan Peso", "Uzbekistani Som", "Venezuelan Bolívar", "Vietnamese Đồng", "Vanuatu Vatu", "Samoan Tala", "Central African Cfa Franc", "East Caribbean Dollar", "West African Cfa Franc", "Cfp Franc", "Yemeni Rial", "South African Rand", "Zambian Kwacha" ], "x-enum-varnames": [ "CurrencyAED", "CurrencyAFN", "CurrencyALL", "CurrencyAMD", "CurrencyANG", "CurrencyAOA", "CurrencyARS", "CurrencyAUD", "CurrencyAWG", "CurrencyAZN", "CurrencyBAM", "CurrencyBBD", "CurrencyBDT", "CurrencyBGN", "CurrencyBIF", "CurrencyBMD", "CurrencyBND", "CurrencyBOB", "CurrencyBRL", "CurrencyBSD", "CurrencyBWP", "CurrencyBZD", "CurrencyCAD", "CurrencyCDF", "CurrencyCHF", "CurrencyCLP", "CurrencyCNY", "CurrencyCOP", "CurrencyCRC", "CurrencyCVE", "CurrencyCZK", "CurrencyDJF", "CurrencyDKK", "CurrencyDOP", "CurrencyDZD", "CurrencyEEK", "CurrencyEGP", "CurrencyETB", "CurrencyEUR", "CurrencyFJD", "CurrencyFKP", "CurrencyGBP", "CurrencyGEL", "CurrencyGIP", "CurrencyGMD", "CurrencyGNF", "CurrencyGTQ", "CurrencyGYD", "CurrencyHKD", "CurrencyHNL", "CurrencyHRK", "CurrencyHTG", "CurrencyHUF", "CurrencyIDR", "CurrencyILS", "CurrencyINR", "CurrencyISK", "CurrencyJMD", "CurrencyJPY", "CurrencyKES", "CurrencyKGS", "CurrencyKHR", "CurrencyKMF", "CurrencyKRW", "CurrencyKYD", "CurrencyKZT", "CurrencyLAK", "CurrencyLBP", "CurrencyLKR", "CurrencyLRD", "CurrencyLSL", "CurrencyLTL", "CurrencyLVL", "CurrencyMAD", "CurrencyMDL", "CurrencyMGA", "CurrencyMKD", "CurrencyMNT", "CurrencyMOP", "CurrencyMRO", "CurrencyMUR", "CurrencyMVR", "CurrencyMWK", "CurrencyMXN", "CurrencyMYR", "CurrencyMZN", "CurrencyNAD", "CurrencyNGN", "CurrencyNIO", "CurrencyNOK", "CurrencyNPR", "CurrencyNZD", "CurrencyPAB", "CurrencyPEN", "CurrencyPGK", "CurrencyPHP", "CurrencyPKR", "CurrencyPLN", "CurrencyPYG", "CurrencyQAR", "CurrencyRON", "CurrencyRSD", "CurrencyRUB", "CurrencyRWF", "CurrencySAR", "CurrencySBD", "CurrencySCR", "CurrencySEK", "CurrencySGD", "CurrencySHP", "CurrencySLL", "CurrencySOS", "CurrencySRD", "CurrencySTD", "CurrencySVC", "CurrencySZL", "CurrencyTHB", "CurrencyTJS", "CurrencyTOP", "CurrencyTRY", "CurrencyTTD", "CurrencyTWD", "CurrencyTZS", "CurrencyUAH", "CurrencyUGX", "CurrencyUSD", "CurrencyUYU", "CurrencyUZS", "CurrencyVEF", "CurrencyVND", "CurrencyVUV", "CurrencyWST", "CurrencyXAF", "CurrencyXCD", "CurrencyXOF", "CurrencyXPF", "CurrencyYER", "CurrencyZAR", "CurrencyZMW" ] }, "forms.Customer": { "type": "object", "properties": { "id": { "description": "The unique identifier for the customer.", "type": "string" }, "name": { "description": "The name of the customer.", "type": "string", "example": "PingCAP" } } }, "forms.CustomerBills": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "customerName": { "description": "The name of the customer.", "type": "string", "example": "PingCAP" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.DataAPIUsageExplore": { "type": "object", "properties": { "month": { "type": "integer" }, "network_usage": { "type": "integer" }, "request_count": { "type": "integer" }, "tenant_id": { "type": "integer" } } }, "forms.DimensionValue": { "type": "object", "additionalProperties": { "type": "string" } }, "forms.DimensionValueParameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.DimensionValue" } }, "forms.Discount": { "type": "object", "properties": { "binded_billing_config_id": { "type": "integer" }, "closed_at": { "type": "string" }, "clusters": { "type": "array", "items": { "type": "string" } }, "customers": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "discount": { "type": "string" }, "discount_code": { "type": "string" }, "discount_id": { "type": "integer" }, "discount_sid": { "type": "string" }, "expired_at": { "type": "string" }, "note": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "provider": { "$ref": "#/definitions/forms.ProviderEnum" }, "started_at": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "unit_filters": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } }, "usage": { "type": "string" } } }, "forms.DiscountForOpenAPI": { "type": "object", "properties": { "customers": { "description": "The discount can only apply on the costs from the specific customers, `empty` means no restrictions", "type": "array", "items": { "type": "string" } }, "description": { "description": "The description of the discount.", "type": "string" }, "discountCode": { "description": "The unique code for the discount.", "type": "string", "example": "498c7f44-656f-4944-b455-0695faa5d4f9" }, "expiryDate": { "description": "The expiration date of the discount. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\".", "type": "string", "example": "2023-12-01T00:00:00Z" }, "percentageDiscount": { "description": "The percentage deducted from the original price. For example, a 20% discount on a $100 item would result in a discounted price of $80.", "type": "string", "example": "20%" }, "provider": { "description": "The discount can only apply on the costs from the specific provider, `all` means no restrictions", "allOf": [ { "$ref": "#/definitions/forms.ProviderEnum" } ], "example": "all" }, "services": { "description": "The services to which the discount is applicable.", "type": "string", "example": "Node Compute, Changefeed," }, "startDate": { "description": "The effective start date of the discount. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\"`.", "type": "string", "example": "2023-11-01T00:00:00Z" }, "status": { "description": "The current status of the discount.", "allOf": [ { "$ref": "#/definitions/forms.DiscountState" } ], "example": "valid" } } }, "forms.DiscountInfo": { "type": "object", "properties": { "discount": { "type": "string" } } }, "forms.DiscountState": { "type": "string", "enum": [ "valid", "expired", "reclaimed", "invalid" ], "x-enum-varnames": [ "DiscountState_Valid", "DiscountState_Expired", "DiscountState_Reclaimed", "DiscountState_Invalid" ] }, "forms.EditionDimensionValue": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.DimensionValueParameters" } }, "forms.ExpressionLabel": { "type": "object", "properties": { "label": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } }, "forms.Groups": { "type": "object", "properties": { "groupBy": { "description": "Specifies categories for grouping query results. Value options are:\n- \"service\": Group query results by service type\n- \"product\": Group query results by product type (TiDB Dedicated, TiDB Serverless, or Support Plan)\n- \"project\": Group query results by project IDs\n- \"cluster\": Group query results by cluster IDs\n- \"provider\": Group query results by cloud provider\n- \"region\": Group query results by cloud provider region", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerTrendsBreakdownKey" } }, "timeGranularity": { "description": "Determines the time-based organization of query results. Value options are:\n- \"day\": Query results are organized daily\n- \"month\": Query results are organized monthly\n- \"total\": Query results are organized as a single total", "allOf": [ { "$ref": "#/definitions/forms.CostExplorerTrendsTimeGroup" } ] } } }, "forms.Invoice": { "type": "object", "properties": { "binded_billing_config_id": { "type": "string", "example": "0" }, "brief": { "type": "boolean" }, "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "category_use_item": { "type": "boolean" }, "charge_mode": { "description": "ChargeMode is the charge behavior chosen at push time, \"auto\" or \"manual\".", "type": "string" }, "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "end_date": { "type": "string" }, "invoice_id": { "type": "string", "example": "0" }, "kind_category_units_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryItemCosts" } }, "label_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.LabelCosts" } }, "order": { "type": "integer" }, "parent_invoice_id": { "type": "integer" }, "payment_code": { "type": "string" }, "payment_type": { "type": "string" }, "raw_price": { "type": "string" }, "service_plan": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "stripe_invoice_id": { "description": "StripeInvoiceID is populated after the invoice has been pushed to Stripe.", "type": "string" }, "tax_rate": { "$ref": "#/definitions/forms.TaxRate" }, "tenant_id": { "type": "string", "example": "0" }, "type": { "type": "string" }, "unit_costs": { "description": "unused?", "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.InvoiceAppliedFXRate": { "type": "object", "properties": { "base": { "$ref": "#/definitions/forms.Currency" }, "date": { "type": "string" }, "target": { "$ref": "#/definitions/forms.Currency" }, "value": { "type": "string" } } }, "forms.InvoiceForOpsList": { "type": "object", "properties": { "binded_billing_config_id": { "type": "string", "example": "0" }, "brief": { "type": "boolean" }, "category_item_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "category_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.Price" } }, "category_use_item": { "type": "boolean" }, "charge_mode": { "description": "ChargeMode is the charge behavior chosen at push time, \"auto\" or \"manual\".", "type": "string" }, "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "end_date": { "type": "string" }, "from": { "type": "string" }, "invoice_id": { "type": "string", "example": "0" }, "kind_category_units_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryItemCosts" } }, "label_unit_costs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.LabelCosts" } }, "order": { "type": "integer" }, "parent_invoice_id": { "type": "integer" }, "payment_code": { "type": "string" }, "payment_type": { "type": "string" }, "raw_price": { "type": "string" }, "service_plan": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "stripe_invoice_id": { "description": "StripeInvoiceID is populated after the invoice has been pushed to Stripe.", "type": "string" }, "tax_rate": { "$ref": "#/definitions/forms.TaxRate" }, "tenant_id": { "type": "string", "example": "0" }, "tenant_name": { "type": "string" }, "to": { "type": "string" }, "type": { "type": "string" }, "unit_costs": { "description": "unused?", "type": "array", "items": { "$ref": "#/definitions/forms.UnitCosts" } } } }, "forms.LabelCosts": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.CategoryCosts" } }, "forms.MCPOBillingConfig": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/definitions/forms.Discount" } }, "effective_date": { "type": "string" }, "payment_code": { "type": "string" }, "reseller_id": { "type": "string", "example": "0" }, "support_plan": { "$ref": "#/definitions/forms.SupportPlanInput" }, "tenant_id": { "type": "string", "example": "0" } } }, "forms.ModifierAndCreator": { "type": "object", "properties": { "creator": { "type": "string" }, "describe": { "description": "optional", "type": "string" }, "modifier": { "type": "string" } } }, "forms.MonthlycostExplorerResult": { "type": "object", "properties": { "binded_invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "credits_costs": { "$ref": "#/definitions/forms.Costs" }, "invoice_costs": { "$ref": "#/definitions/forms.Costs" }, "invoice_generated": { "type": "boolean" }, "total_costs": { "$ref": "#/definitions/forms.Costs" }, "unbind_invoice_costs": { "$ref": "#/definitions/forms.Costs" } } }, "forms.MspBills": { "type": "object", "properties": { "overview": { "description": "The overall information for a bill in the specified organization.", "allOf": [ { "$ref": "#/definitions/forms.BillsOverview" } ] }, "summaryByCustomer": { "description": "Month of bills happens to a specific MSP.", "type": "array", "items": { "$ref": "#/definitions/forms.SummaryByCustomer" } }, "summaryByService": { "description": "A breakdown of the bill by service.", "type": "array", "items": { "$ref": "#/definitions/forms.BillsServiceCosts" } } } }, "forms.MspCredit": { "type": "object", "properties": { "credit": { "description": "The total amount of credit.", "type": "string", "example": "1000.00" }, "creditCode": { "description": "The code of a credit.", "type": "string", "example": "498c7f44-656f-4944-b455-0695faa5d4f9" }, "expiryDate": { "description": "Expired date of a credit.", "type": "string", "example": "2023-12-01T00:00:00Z" }, "remainingCredit": { "description": "The remaining amount of a credit.", "type": "string", "example": "1000.00" }, "services": { "description": "The service to which a credit is applicable.", "type": "string", "example": "General Product" }, "startDate": { "description": "Effective start date of a credit.", "type": "string", "example": "2023-11-01T00:00:00Z" }, "status": { "description": "The status of a credit.", "type": "string", "example": "active" } } }, "forms.MspDiscount": { "type": "object", "properties": { "description": { "description": "The description of a discount.", "type": "string" }, "discountCode": { "description": "The code of a discount.", "type": "string", "example": "498c7f44-656f-4944-b455-0695faa5d4f9" }, "expiryDate": { "description": "Expired date of a credit.", "type": "string", "example": "2023-12-01T00:00:00Z" }, "percentageDiscount": { "description": "The percentage is deducted from the original price. For example, a 20% discount on a $100 item would result in a discounted price of $80.", "type": "string", "example": "20%" }, "services": { "description": "The service to which a discount is applicable.", "type": "string", "example": "Node Compute, Changefeed," }, "startDate": { "description": "Effective start date of a credit.", "type": "string", "example": "2023-11-01T00:00:00Z" }, "status": { "description": "The status of a discount.", "type": "string", "example": "valid" } } }, "forms.Notification": { "type": "object", "properties": { "in_app_content": { "type": "string" }, "is_read": { "type": "boolean" }, "mark_as_id": { "type": "string" }, "notification_group": { "type": "string" }, "notification_id": { "type": "string" }, "send_at": { "type": "string" }, "send_by": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "subscriber_id": { "type": "string" }, "transaction_id": { "type": "string" }, "worker_flow_name": { "type": "string" } } }, "forms.Notifications": { "type": "object", "properties": { "count": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/forms.Notification" } }, "has_more": { "type": "boolean" }, "page_query": { "$ref": "#/definitions/forms.PageQuery" } } }, "forms.NotificationsSummary": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string" } }, "count": { "type": "integer" }, "date": { "type": "string" } } }, "forms.OKType": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } }, "forms.OpenCostsBillsOtherName": { "type": "object", "properties": { "chargeName": { "type": "string", "example": "Support Plan" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "roundingAdjustment": { "description": "The display adjustment caused by splitting and merging credits/discounts at different rounding boundaries.", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits` - `roundingAdjustment`.", "type": "string", "example": "0.00" } } }, "forms.OpenCostsBillsOverview": { "type": "object", "properties": { "billedMonth": { "description": "The month or date range covered by this open cost result.", "type": "string", "example": "2023-09" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "roundingAdjustment": { "description": "The display adjustment caused by splitting and merging credits/discounts at different rounding boundaries.", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits` - `roundingAdjustment`.", "type": "string", "example": "0.00" } } }, "forms.OpenCostsBillsProjects": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "projectName": { "description": "The name of a project in the specified organization.", "type": "string", "example": "prod-project" }, "roundingAdjustment": { "description": "The display adjustment caused by splitting and merging credits/discounts at different rounding boundaries.", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits` - `roundingAdjustment`.", "type": "string", "example": "0.00" } } }, "forms.OpenCostsBillsServiceCosts": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "roundingAdjustment": { "description": "The display adjustment caused by splitting and merging credits/discounts at different rounding boundaries.", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "serviceCosts": { "type": "array", "items": { "$ref": "#/definitions/forms.OpenCostsBillsServiceCosts" } }, "serviceName": { "description": "The name of services provided by TiDB Cloud.", "type": "string", "example": "TiDB Dedicated" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits` - `roundingAdjustment`.", "type": "string", "example": "0.00" } } }, "forms.OpenCostsSummaryByProject": { "type": "object", "properties": { "otherCharges": { "description": "These charges occur not only within a project but also across the entire organization.", "type": "array", "items": { "$ref": "#/definitions/forms.OpenCostsBillsOtherName" } }, "projects": { "description": "The projects in the specified organization.", "type": "array", "items": { "$ref": "#/definitions/forms.OpenCostsBillsProjects" } } } }, "forms.OpsNotification": { "type": "object", "properties": { "notification": { "$ref": "#/definitions/forms.Notification" }, "roles": { "type": "string" } } }, "forms.OpsNotifications": { "type": "object", "properties": { "count": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/forms.OpsNotification" } }, "has_more": { "type": "boolean" }, "page_query": { "$ref": "#/definitions/forms.PageQuery" } } }, "forms.OrgSupportPlanForOpenAPI": { "type": "object", "properties": { "activeDate": { "description": "The effective date of the support plan for the organization. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\"`.", "type": "string", "example": "2023-12-01T00:00:00Z" }, "expiredDate": { "description": "The expiration date of the support plan for the organization. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\"`.", "type": "string", "example": "2023-12-01T00:00:00Z" }, "fixedChargePrice": { "description": "The fixed fee for the support plan. If the plan is charged on a pro rata basis (`\"percentage_price\"`), this represents the minimum fee.", "type": "string" }, "level": { "description": "The level of the support plan. By default, the Basic plan is selected.", "allOf": [ { "$ref": "#/definitions/forms.SupportPlanLevel" } ] }, "public": { "description": "Indicates whether the support plan is public. A non-public support plan might be subject to special contract terms and cannot be upgraded or downgraded.", "type": "boolean" }, "supportPricePercentage": { "description": "The prorated fee ratio for the support plan.", "type": "string" }, "type": { "description": "Indicates whether the support plan is charged on a pro rata basis (`\"percentage_price\"`) or a fixed fee (`\"fixed_price\"`).", "allOf": [ { "$ref": "#/definitions/forms.SupportPlanType" } ] } } }, "forms.PackageInfo": { "type": "object", "properties": { "credits": { "type": "string" }, "credits_enable": { "type": "boolean" }, "credits_only": { "type": "boolean" }, "description": { "type": "string" }, "discount": { "description": "no need unit count for now, only pay for need\nUnitCount []UnitCount", "type": "string" }, "expression_labels": { "type": "array", "items": { "$ref": "#/definitions/forms.ExpressionLabel" } }, "extra_pricing_infos": { "type": "array", "items": { "$ref": "#/definitions/forms.PricingInfo" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "package_id": { "type": "integer" }, "tenant_max_binded_times": { "type": "integer" }, "unit_prices": { "$ref": "#/definitions/forms.UnitPrices" }, "version": { "type": "integer" } } }, "forms.PackageInfoInput": { "type": "object", "properties": { "credits": { "type": "string" }, "credits_enable": { "type": "boolean" }, "credits_only": { "type": "boolean" }, "description": { "type": "string" }, "discount": { "type": "string" }, "expression_labels": { "type": "array", "items": { "$ref": "#/definitions/forms.ExpressionLabel" } }, "extra_pricing_infos": { "type": "array", "items": { "$ref": "#/definitions/forms.PricingInfo" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "tenant_max_binded_times": { "type": "integer" }, "unit_prices": { "$ref": "#/definitions/forms.UnitPrices" } } }, "forms.PageQuery": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" } } }, "forms.PartnerBillsCostExplorer": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/forms.PartnerBillsCostExplorerElements" } }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerBillsCostExplorerBreakdown": { "type": "object", "properties": { "billedDate": { "type": "string", "example": "2023-01-01" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "detailKey": { "type": "string", "example": "122" }, "detailName": { "type": "string", "example": "customer01" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerBillsCostExplorerElements": { "type": "object", "properties": { "billedDate": { "type": "string", "example": "2023-01-01" }, "breakdown": { "type": "array", "items": { "$ref": "#/definitions/forms.PartnerBillsCostExplorerBreakdown" } }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerBillsDetail": { "type": "object", "properties": { "billedDate": { "description": "The date when this bill happens.", "type": "string" }, "clusterName": { "description": "Name of the cluster.", "type": "string" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "customerName": { "type": "string", "example": "PingCAP" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "projectName": { "description": "Name of the project.", "type": "string" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "servicePathName": { "description": "Name of the service.", "type": "string" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerBillsDetails": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/forms.PartnerBillsDetail" } } } }, "forms.PartnerBillsExplorer": { "type": "object", "properties": { "overview": { "description": "The overall information for a bill in the specified organization.", "allOf": [ { "$ref": "#/definitions/forms.BillsOverview" } ] }, "summaryByCustomer": { "description": "A breakdown of the bill by customers.", "allOf": [ { "$ref": "#/definitions/forms.SummaryBillsByCustomer" } ] }, "summaryByProject": { "description": "A breakdown of the bill by project.", "allOf": [ { "$ref": "#/definitions/forms.SummaryByProject" } ] }, "summaryByService": { "description": "A breakdown of the bill by services.", "type": "array", "items": { "$ref": "#/definitions/forms.PartnerBillsServiceCosts" } } } }, "forms.PartnerBillsServiceCosts": { "type": "object", "properties": { "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "serviceCosts": { "description": "A breakdown of the bill by service.", "type": "array", "items": { "$ref": "#/definitions/forms.PartnerBillsServiceCosts" } }, "serviceName": { "description": "The name of services provided by TiDB Cloud.", "type": "string", "example": "TiDB Dedicated" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerConfigs": { "type": "object", "properties": { "enableBillsView": { "description": "Determines whether customers can view their bills with list prices in the TiDB Cloud console.", "type": "boolean", "example": true } } }, "forms.PartnerInvoicedBillsDetail": { "type": "object", "properties": { "billedDate": { "description": "The date when this bill happens.", "type": "string" }, "clusterName": { "description": "Name of the cluster.", "type": "string" }, "credits": { "description": "The total credits held by the organization in this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "customerName": { "type": "string", "example": "PingCAP" }, "discounts": { "description": "The total amount of discounts applied to this bill. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "invoicedDate": { "type": "string" }, "paymentCode": { "type": "string" }, "projectName": { "description": "Name of the project.", "type": "string" }, "runningTotal": { "description": "The sum of services that the specified organization has consumed during this bill period. The value of this field is expressed in cents (100ths of one US Dollar).", "type": "string", "example": "0.00" }, "servicePathName": { "description": "Name of the service.", "type": "string" }, "totalCost": { "description": "The total amount that the specified organization should pay for this bill. The value of this field is expressed in cents (100ths of one US Dollar).\n`total_cost` = `running_total` - `discounts` - `credits`.", "type": "string", "example": "0.00" } } }, "forms.PartnerInvoicedBillsDetails": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/forms.PartnerInvoicedBillsDetail" } } } }, "forms.PartnerTrendsArgs": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/forms.ClusterOpenAPI" } }, "customers": { "type": "array", "items": { "$ref": "#/definitions/forms.Customer" } }, "projects": { "type": "array", "items": { "$ref": "#/definitions/forms.ProjectOpenAPI" } }, "providers": { "type": "array", "items": { "$ref": "#/definitions/forms.Provider" } }, "services": { "description": "The Identifier of TiDB Cloud services consists of 3 levels. For example, \"service\": \"TiDB Dedicated - Node Compute - TiFlash\" consists of the following 3 levels.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } } } }, "forms.PartnerTrendsFilter": { "type": "object", "properties": { "clusters": { "description": "A list of cluster IDs to include in the query.", "type": "array", "items": { "type": "string" } }, "customers": { "type": "array", "items": { "type": "string" } }, "projects": { "description": "A list of project IDs to include in the query.", "type": "array", "items": { "type": "string" } }, "providers": { "description": "A list of providers to include in the query.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerProvider" } }, "services": { "description": "A list of TiDB Cloud services to include in the query.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } }, "timeRange": { "description": "The time period for the query.", "allOf": [ { "$ref": "#/definitions/forms.TimeRange" } ] } } }, "forms.PartnerTrendsInput": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/forms.PartnerTrendsFilter" }, "groups": { "$ref": "#/definitions/forms.Groups" } } }, "forms.PaymentCodeUpdateQuery": { "type": "object", "properties": { "payment_code": { "type": "string" }, "payment_sub_code": { "type": "string" } } }, "forms.PaymentForOpenAPI": { "type": "object", "properties": { "payable": { "description": "Indicates whether the account is in a payable state.", "type": "boolean" }, "type": { "description": "The type of payment method currently active.", "allOf": [ { "$ref": "#/definitions/forms.PaymentType" } ] } } }, "forms.PaymentMeta": { "type": "object", "properties": { "aws_cppo_discount": { "type": "string" }, "is_aws_cppo_payment": { "type": "boolean" }, "is_third_party": { "type": "boolean" } } }, "forms.PaymentMethod": { "type": "object", "properties": { "binded_billing_config_id": { "type": "integer" }, "invoiceable": { "type": "boolean" }, "managed_by_sales": { "type": "boolean" }, "payable": { "type": "boolean" }, "payment_code": { "type": "string" }, "payment_method_id": { "type": "integer" }, "payment_method_meta": { "$ref": "#/definitions/forms.PaymentMeta" }, "payment_sub_code": { "type": "string" }, "payment_type": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" }, "unpayable_at": { "type": "string" } } }, "forms.PaymentMethodType": { "type": "object", "properties": { "payable": { "type": "boolean" }, "payment_type": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.PaymentType": { "type": "string", "enum": [ "none", "aws", "aws_cppo", "gcp", "credit_card", "wire_transfer" ], "x-enum-varnames": [ "PaymentType_None", "PaymentType_AWS", "PaymentType_AWSCPPO", "PaymentType_GCP", "PaymentType_CreditCard", "PaymentType_WireTransfer" ] }, "forms.PlanInfo": { "type": "object", "properties": { "binded_billing_config_id": { "type": "integer" }, "closed_at": { "type": "string" }, "plan": { "type": "string" }, "plan_id": { "type": "integer" }, "started_at": { "type": "string" }, "status": { "type": "string" } } }, "forms.Price": { "type": "object", "properties": { "cost_price": { "type": "string" }, "discount_price": { "type": "string" }, "order": { "type": "integer" }, "raw_price": { "type": "string" } } }, "forms.PricingInfo": { "type": "object", "properties": { "discount": { "type": "string" }, "expression_labels": { "type": "array", "items": { "$ref": "#/definitions/forms.ExpressionLabel" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "unit_prices": { "$ref": "#/definitions/forms.UnitPrices" } } }, "forms.Project": { "type": "object", "properties": { "id": { "type": "string", "example": "0" }, "name": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "type": { "type": "integer" } } }, "forms.ProjectOpenAPI": { "type": "object", "properties": { "id": { "type": "string", "example": "0" }, "name": { "type": "string" }, "status": { "type": "string" } } }, "forms.Provider": { "type": "object", "properties": { "name": { "description": "Name of the cloud provider", "type": "string" }, "regions": { "description": "Name of the region", "type": "array", "items": { "type": "string" } } } }, "forms.ProviderEnum": { "type": "string", "enum": [ "all", "AWS", "GCP", "AZURE", "Alicloud", "PINGCAP" ], "x-enum-varnames": [ "Provider_All", "Provider_AWS", "Provider_GCP", "Provider_Azure", "Provider_AliCloud", "Provider_PINGCAP" ] }, "forms.Purchaser": { "type": "object", "properties": { "emailId": { "type": "string" }, "objectId": { "type": "string" }, "puid": { "type": "string" }, "tenantId": { "type": "string" } } }, "forms.RecalculateBillsPreviewReq": { "type": "object", "required": [ "end_date", "start_date" ], "properties": { "end_date": { "type": "string" }, "start_date": { "type": "string" } } }, "forms.RecalculatePreviewItem": { "type": "object", "properties": { "abs_diff_cost": { "type": "string" }, "abs_diff_credits": { "type": "string" }, "abs_diff_raw": { "type": "string" }, "abs_diff_rounding_adjustment": { "type": "string" }, "billing_config_id": { "type": "string", "example": "0" }, "comparison_scope": { "type": "string" }, "diff_cost": { "type": "string" }, "diff_credits": { "type": "string" }, "diff_raw": { "type": "string" }, "diff_rounding_adjustment": { "type": "string" }, "error": { "type": "string" }, "input_bundle_id": { "type": "string", "example": "0" }, "invoice_date": { "type": "string" }, "invoice_id": { "type": "string", "example": "0" }, "invoice_type": { "type": "string" }, "legacy_cost_price": { "type": "string" }, "legacy_credit_package_ids": { "type": "string" }, "legacy_credits": { "type": "string" }, "legacy_discount_ids": { "type": "string" }, "legacy_discounts": { "type": "string" }, "legacy_raw_price": { "type": "string" }, "legacy_rounding_adjustment": { "type": "string" }, "legacy_row_count": { "type": "integer" }, "match": { "type": "boolean" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "missing": { "type": "array", "items": { "type": "string" } }, "period_month": { "type": "string" }, "risks": { "type": "array", "items": { "type": "string" } }, "snapshot_cost_price": { "type": "string" }, "snapshot_credit_package_ids": { "type": "string" }, "snapshot_credits": { "type": "string" }, "snapshot_discount_ids": { "type": "string" }, "snapshot_discounts": { "type": "string" }, "snapshot_fact_count": { "type": "integer" }, "snapshot_raw_price": { "type": "string" }, "snapshot_rounding_adjustment": { "type": "string" }, "source_mode": { "type": "string" }, "source_run_id": { "type": "string", "example": "0" }, "status": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "window_end": { "type": "string" }, "window_start": { "type": "string" } } }, "forms.RecalculatePreviewResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/forms.RecalculatePreviewItem" } }, "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "mode": { "type": "string" }, "status": { "type": "string" }, "summary": { "$ref": "#/definitions/forms.RecalculatePreviewSummary" } } }, "forms.RecalculatePreviewSummary": { "type": "object", "properties": { "diff_cost": { "type": "string" }, "diff_raw": { "type": "string" }, "diff_rounding_adjustment": { "type": "string" }, "error_count": { "type": "integer" }, "found_count": { "type": "integer" }, "item_count": { "type": "integer" }, "legacy_cost_price": { "type": "string" }, "legacy_raw_price": { "type": "string" }, "legacy_rounding_adjustment": { "type": "string" }, "match_count": { "type": "integer" }, "running_count": { "type": "integer" }, "snapshot_cost_price": { "type": "string" }, "snapshot_raw_price": { "type": "string" }, "snapshot_rounding_adjustment": { "type": "string" } } }, "forms.RecalculateRun": { "type": "object", "properties": { "billing_config_id": { "type": "string", "example": "0" }, "created_at": { "type": "string" }, "error_message": { "type": "string" }, "finished_at": { "type": "string" }, "input_bundle_id": { "type": "string", "example": "0" }, "invoice_date": { "type": "string" }, "invoice_type": { "type": "string" }, "period_month": { "type": "string" }, "run_id": { "type": "string", "example": "0" }, "source_mode": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "string", "example": "0" }, "window_end": { "type": "string" }, "window_start": { "type": "string" } } }, "forms.RecalculateRunListResponse": { "type": "object", "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "runs": { "type": "array", "items": { "$ref": "#/definitions/forms.RecalculateRun" } }, "total_results": { "type": "integer" } } }, "forms.RecalculateStartItem": { "type": "object", "properties": { "error": { "type": "string" }, "missing": { "type": "array", "items": { "type": "string" } }, "source_run_id": { "type": "string", "example": "0" }, "status": { "type": "string" } } }, "forms.RecalculateStartResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/forms.RecalculateStartItem" } }, "mode": { "type": "string" }, "status": { "type": "string" } } }, "forms.RechargeCreditsPlan": { "type": "object", "properties": { "created_at": { "type": "string" }, "cycle": { "type": "string" }, "expired_date": { "type": "string" }, "internal": { "type": "boolean" }, "note": { "type": "string" }, "plan_id": { "type": "integer" }, "rule": { "$ref": "#/definitions/forms.RechargeCreditsPlanRule" }, "source": { "type": "string" }, "start_date": { "type": "string" }, "updated_at": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "string" } } }, "forms.RechargeCreditsPlanInput": { "type": "object", "properties": { "cycle": { "type": "string" }, "internal": { "type": "boolean" }, "rule": { "$ref": "#/definitions/forms.RechargeCreditsPlanRule" }, "usage": { "type": "string" }, "value": { "type": "string" } } }, "forms.RechargeCreditsPlanRule": { "type": "object", "properties": { "first_credits_convertor": { "type": "string" }, "first_cycle_finished_at": { "type": "string" }, "first_cycle_started_at": { "type": "string" } } }, "forms.ReferralCodeResponse": { "type": "object", "properties": { "campaign_id": { "type": "integer" }, "campaign_name": { "type": "string" }, "code": { "type": "string" }, "referral_count": { "type": "integer" }, "share_link": { "type": "string" }, "total_earned": { "type": "string" } } }, "forms.ReferralRewardReq": { "type": "object", "required": [ "event_type", "referral_code" ], "properties": { "credits_amount": { "type": "string" }, "event_type": { "type": "string" }, "referee_tenant_id": { "type": "integer" }, "referral_code": { "type": "string" } } }, "forms.ReferralRewardResp": { "type": "object", "properties": { "credits_code": { "type": "string" }, "reward_amount": { "type": "string" }, "rewarded": { "type": "boolean" }, "skip_reason": { "type": "string" } } }, "forms.SKUGroup": { "type": "object", "properties": { "category": { "type": "string" }, "created_at": { "description": "optional", "type": "string" }, "group_id": { "description": "optional", "type": "integer" }, "measure_unit": { "description": "optional", "type": "string" }, "name": { "type": "string" }, "price_expression": { "description": "optional", "type": "object", "additionalProperties": { "type": "string" } }, "price_formula": { "type": "string" }, "price_type": { "type": "string" }, "sku_group_type": { "type": "string" }, "unit_key_pattern": { "type": "string", "minLength": 1 }, "updated_at": { "description": "optional", "type": "string" } } }, "forms.SetupIntent": { "type": "object", "properties": { "client_secret": { "type": "string" }, "public_key": { "type": "string" } } }, "forms.SkuInfo": { "type": "object", "properties": { "category": { "type": "string" }, "commodity_code": { "type": "string" }, "description": { "type": "string" }, "edition_code": { "type": "string" }, "measure_unit": { "type": "string" }, "modifier_info": { "$ref": "#/definitions/forms.ModifierAndCreator" }, "price": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "sku_template_id": { "type": "integer" }, "unit_key": { "type": "string" } } }, "forms.SkuInfoQuery": { "type": "object", "properties": { "commodity_code": { "description": "optional", "type": "string" }, "edition_code": { "description": "optional", "type": "string" }, "sku_template_id": { "description": "optional", "type": "integer" }, "unit_key": { "description": "optional", "type": "string" } } }, "forms.SkuModify": { "type": "object", "properties": { "modifyMap": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.SkuInfo" } } } }, "forms.SkuTemplate": { "type": "object", "properties": { "ID": { "type": "integer" }, "commodity_code": { "type": "string" }, "created_at": { "type": "string" }, "edition_code": { "type": "string" }, "modifier_info": { "$ref": "#/definitions/forms.ModifierAndCreator" }, "template": { "$ref": "#/definitions/forms.DimensionValue" }, "updated_at": { "type": "string" } } }, "forms.SkuTemplateModify": { "type": "object", "properties": { "modifyID": { "type": "integer" }, "sku_template": { "$ref": "#/definitions/forms.SkuTemplate" } } }, "forms.SkuTemplateQuery": { "type": "object", "properties": { "commodity_code": { "description": "optional", "type": "string" }, "edition_code": { "description": "optional", "type": "string" } } }, "forms.SpendLimitInfo": { "type": "object", "properties": { "biz_data": { "type": "string" }, "biz_type": { "type": "string" }, "cost_type": { "type": "string" }, "costs": { "type": "string" }, "has_serverless_free_credits": { "type": "boolean" }, "interval": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "range_id": { "type": "integer" }, "range_id_str": { "type": "string", "example": "0" }, "range_type": { "type": "string" }, "spendlimit_setting_id": { "type": "integer" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.SpendLimitSetting": { "type": "object", "properties": { "biz_data": { "type": "string" }, "biz_type": { "type": "string" }, "cost_type": { "type": "string" }, "has_serverless_free_credits": { "type": "boolean" }, "interval": { "type": "string" }, "limit": { "type": "string" }, "name": { "type": "string" }, "range_id": { "type": "integer" }, "range_id_str": { "type": "string", "example": "0" }, "range_type": { "type": "string" }, "spendlimit_setting_id": { "type": "integer" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.SpendLimitSettingInput": { "type": "object", "properties": { "biz_type": { "type": "string" }, "cost_type": { "type": "string" }, "interval": { "type": "string" }, "limit": { "type": "string" }, "range_id": { "type": "integer" }, "range_type": { "type": "string" } } }, "forms.SpendLimitThreshold": { "type": "object", "properties": { "biz_type": { "type": "string" }, "proportion": { "type": "string" }, "spend_limit_id": { "type": "integer" }, "tenant_id": { "type": "integer" }, "threshold_id": { "type": "integer" } } }, "forms.StripeCustomerInfo": { "type": "object", "properties": { "address": { "$ref": "#/definitions/forms.Address" }, "dbaas_id": { "type": "string" }, "default_source": { "type": "string" }, "description": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "forms.StripeInvoice": { "type": "object", "properties": { "amount_due": { "type": "string" }, "amount_paid": { "type": "string" }, "created": { "type": "string", "example": "0" }, "credit_used": { "type": "string" }, "currency": { "type": "string" }, "due_date": { "type": "string", "example": "0" }, "id": { "type": "string" }, "invoice_pdf": { "type": "string" }, "number": { "type": "string" }, "paid": { "type": "boolean" }, "status": { "type": "string" }, "total": { "type": "string" } } }, "forms.StripeInvoiceDetail": { "type": "object", "properties": { "amount_due": { "type": "string" }, "amount_paid": { "type": "string" }, "client_secret": { "type": "string" }, "created": { "type": "string", "example": "0" }, "credit_used": { "type": "string" }, "currency": { "type": "string" }, "due_date": { "type": "string", "example": "0" }, "id": { "type": "string" }, "invoice_pdf": { "type": "string" }, "number": { "type": "string" }, "paid": { "type": "boolean" }, "payment_intent_id": { "type": "string" }, "payment_intent_status": { "type": "string" }, "public_key": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "string" } } }, "forms.StripePaymentMethod": { "type": "object", "properties": { "billing_details": { "$ref": "#/definitions/forms.BillingDetails" }, "card": { "$ref": "#/definitions/forms.Card" }, "id": { "type": "string" } } }, "forms.Subscription": { "type": "object", "properties": { "accepted_date": { "type": "string" }, "accepted_user": { "type": "string" }, "contract_email": { "type": "string" }, "file_path": { "type": "string" }, "rejected_date": { "type": "string" }, "rejected_user": { "type": "string" }, "status": { "type": "string" }, "subscription_id": { "type": "integer" }, "tenant_id": { "type": "integer" } } }, "forms.SubscriptionChange": { "type": "object", "properties": { "change_user": { "type": "string" } } }, "forms.SubscriptionDetails": { "type": "object", "properties": { "allowedCustomerOperations": { "type": "array", "items": { "type": "string" } }, "autoRenew": { "type": "boolean" }, "beneficiary": { "$ref": "#/definitions/forms.Beneficiary" }, "created": { "type": "string" }, "id": { "type": "string" }, "isFreeTrial": { "type": "boolean" }, "isTest": { "type": "boolean" }, "lastModified": { "type": "string" }, "name": { "type": "string" }, "offerId": { "type": "string" }, "planId": { "type": "string" }, "publisherId": { "type": "string" }, "purchaser": { "$ref": "#/definitions/forms.Purchaser" }, "quantity": { "type": "integer" }, "saasSubscriptionStatus": { "type": "string" }, "sandboxType": { "type": "string" }, "sessionMode": { "type": "string" }, "term": { "type": "object", "properties": { "endDate": { "type": "string" }, "startDate": { "type": "string" }, "termUnit": { "type": "string" } } } } }, "forms.SubscriptionInput": { "type": "object", "properties": { "contract_email": { "type": "string" }, "file_path": { "type": "string" } } }, "forms.SubscriptionList": { "type": "object", "properties": { "@nextLink": { "type": "string" }, "subscriptions": { "type": "array", "items": { "$ref": "#/definitions/forms.SubscriptionDetails" } } } }, "forms.SummaryBillsByCustomer": { "type": "object", "properties": { "customers": { "description": "The breakdown of bills by customers of a partner.", "type": "array", "items": { "$ref": "#/definitions/forms.CustomerBills" } }, "otherCharges": { "description": "Costs not incurred by the customer but by the partner, such as support plan for a MSP.", "type": "array", "items": { "$ref": "#/definitions/forms.BillsOtherName" } } } }, "forms.SummaryByCustomer": { "type": "object", "properties": { "customerID": { "description": "The Organization ID of MSP", "type": "integer" }, "mspCustomerBills": { "description": "The bill generated for a specific MSP customer in the specified month.", "allOf": [ { "$ref": "#/definitions/forms.BillsExplorer" } ] } } }, "forms.SummaryByProject": { "type": "object", "properties": { "otherCharges": { "description": "These charges occur not only within a project but also across the entire organization.", "type": "array", "items": { "$ref": "#/definitions/forms.BillsOtherName" } }, "projects": { "description": "The projects in the specified organization.", "type": "array", "items": { "$ref": "#/definitions/forms.BillsProjects" } } } }, "forms.SupportPlan": { "type": "object", "properties": { "fixed_charge_price": { "type": "string" }, "is_support_free_trial": { "type": "boolean" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "support_plan_id": { "type": "integer" }, "support_price_percentage": { "type": "string" }, "tiered_price_rules": { "type": "array", "items": { "$ref": "#/definitions/forms.TieredPriceRule" } }, "type": { "type": "string" } } }, "forms.SupportPlanForOpenAPI": { "type": "object", "properties": { "fixedChargePrice": { "description": "The fixed fee for the support plan. If the plan is charged on a pro rata basis (`\"percentage_price\"`), this represents the minimum fee.", "type": "string" }, "level": { "description": "The level of the support plan. By default, the Basic plan is selected.", "allOf": [ { "$ref": "#/definitions/forms.SupportPlanLevel" } ] }, "public": { "description": "Indicates whether the support plan is public. A non-public support plan might be subject to special contract terms and cannot be upgraded or downgraded.", "type": "boolean" }, "supportPricePercentage": { "description": "The prorated fee ratio for the support plan.", "type": "string" }, "type": { "description": "Indicates whether the support plan is charged on a pro rata basis (`\"percentage_price\"`) or a fixed fee (`\"fixed_price\"`).", "allOf": [ { "$ref": "#/definitions/forms.SupportPlanType" } ] } } }, "forms.SupportPlanInput": { "type": "object", "properties": { "active_date": { "type": "string" }, "expired_date": { "type": "string" }, "fixed_charge_price": { "type": "string" }, "is_support_free_trial": { "type": "boolean" }, "level": { "type": "string" }, "public": { "type": "boolean" }, "support_plan_id": { "type": "integer" }, "support_price_percentage": { "type": "string" }, "tiered_price_rules": { "type": "array", "items": { "$ref": "#/definitions/forms.TieredPriceRule" } }, "type": { "type": "string" } } }, "forms.SupportPlanLevel": { "type": "string", "enum": [ "Basic", "Standard", "Developer", "Enterprise", "Premium" ], "x-enum-varnames": [ "SupportPlanLevel_Basic", "SupportPlanLevel_Standard", "SupportPlanLevel_Developer", "SupportPlanLevel_Enterprise", "SupportPlanLevel_Premium" ] }, "forms.SupportPlanType": { "type": "string", "enum": [ "fixed_price", "percentage_price" ], "x-enum-varnames": [ "SupportPlanType_FixedPrice", "SupportPlanType_PercentagePrice" ] }, "forms.SwitchResponse": { "type": "object", "properties": { "is_allowed": { "type": "boolean" }, "require_credit_card_validation": { "type": "boolean" }, "tenant_id": { "type": "integer" } } }, "forms.TaxIDType": { "type": "string", "enum": [ "ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "no_vat", "nz_gst", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat" ], "x-enum-varnames": [ "TaxIdType_AdNrt", "TaxIdType_AeTrn", "TaxIdType_ArCuit", "TaxIdType_AuAbn", "TaxIdType_AuArn", "TaxIdType_BgUic", "TaxIdType_BoTin", "TaxIdType_BrCnpj", "TaxIdType_BrCpf", "TaxIdType_CaBn", "TaxIdType_CaGstHst", "TaxIdType_CaPstBc", "TaxIdType_CaPstMb", "TaxIdType_CaPstSk", "TaxIdType_CaQst", "TaxIdType_ChVat", "TaxIdType_ClTin", "TaxIdType_CnTin", "TaxIdType_CoNit", "TaxIdType_CrTin", "TaxIdType_DoRcn", "TaxIdType_EcRuc", "TaxIdType_EgTin", "TaxIdType_EsCif", "TaxIdType_EuOssVat", "TaxIdType_EuVat", "TaxIdType_GbVat", "TaxIdType_GeVat", "TaxIdType_HkBr", "TaxIdType_HuTin", "TaxIdType_IdNpwp", "TaxIdType_IlVat", "TaxIdType_InGst", "TaxIdType_IsVat", "TaxIdType_JpCn", "TaxIdType_JpRn", "TaxIdType_JpTrn", "TaxIdType_KePin", "TaxIdType_KrBrn", "TaxIdType_LiUid", "TaxIdType_MxRfc", "TaxIdType_MyFrp", "TaxIdType_MyItn", "TaxIdType_MySst", "TaxIdType_NoVat", "TaxIdType_NzGst", "TaxIdType_PeRuc", "TaxIdType_PhTin", "TaxIdType_RoTin", "TaxIdType_RsPib", "TaxIdType_RuInn", "TaxIdType_RuKpp", "TaxIdType_SaVat", "TaxIdType_SgGst", "TaxIdType_SgUen", "TaxIdType_SiTin", "TaxIdType_SvNit", "TaxIdType_ThVat", "TaxIdType_TrTin", "TaxIdType_TwVat", "TaxIdType_UaVat", "TaxIdType_UsEin", "TaxIdType_UyRuc", "TaxIdType_VeRif", "TaxIdType_VnTin", "TaxIdType_ZaVat" ] }, "forms.TaxRate": { "type": "object", "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "inclusive": { "type": "boolean" }, "rate": { "type": "string" }, "state": { "type": "string" }, "tax_ability_reason": { "type": "string" }, "tax_type": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.TenantBillingCompany": { "type": "object", "properties": { "company_key": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.TenantBillingCompanyInput": { "type": "object", "properties": { "company_key": { "type": "string" } } }, "forms.TenantCloseInfo": { "type": "object", "properties": { "close_actions_status": { "$ref": "#/definitions/forms.CloseActionsStatus" }, "close_policy": { "$ref": "#/definitions/forms.ClosePolicy" }, "closed_at": { "type": "string" }, "credit_risk_level_id": { "type": "integer" }, "reason": { "type": "string" }, "started_at": { "type": "string" }, "status": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.TenantClosePolicy": { "type": "object", "properties": { "close_policy": { "$ref": "#/definitions/forms.ClosePolicy" }, "credit_risk_level_id": { "type": "integer" }, "policy_id": { "type": "integer" }, "reason": { "type": "string" } } }, "forms.TenantClosePolicyInput": { "type": "object", "properties": { "close_policy": { "$ref": "#/definitions/forms.ClosePolicy" } } }, "forms.TenantID": { "type": "object", "properties": { "tenant_id": { "type": "integer" } } }, "forms.TenantPlanInfo": { "type": "object", "properties": { "dev_tier_plan_info": { "$ref": "#/definitions/forms.PlanInfo" }, "effective_discount": { "type": "string" }, "effective_plan": { "type": "string" }, "ondemand_plan_info": { "$ref": "#/definitions/forms.PlanInfo" }, "poc_credits": { "type": "string" }, "poc_plan_info": { "$ref": "#/definitions/forms.PlanInfo" }, "tenant_id": { "type": "integer" }, "tenant_id_str": { "type": "string", "example": "0" } } }, "forms.TenantRechargeCreditsPlan": { "type": "object", "properties": { "cluster_id": { "type": "integer" }, "expired_date": { "type": "string" }, "main_plan_id": { "type": "integer" }, "next_cycle_start_time": { "type": "string" }, "plan_id": { "type": "integer" }, "recharge_times": { "type": "integer" }, "start_date": { "type": "string" }, "tenant_id": { "type": "integer" }, "unit_filters": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterSlim" } } } }, "forms.TieredPriceRule": { "type": "object", "properties": { "lower_bound": { "type": "string" }, "support_price_percentage": { "type": "string" }, "upper_bound": { "type": "string" } } }, "forms.TimeRange": { "type": "object", "properties": { "endDate": { "description": "The end date of the time range. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\"`.", "type": "string" }, "startDate": { "description": "The start date of the time range. The time format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. For example: `\"2023-12-01T00:00:00Z\"`.", "type": "string" } } }, "forms.TrendsArgs": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/forms.ClusterOpenAPI" } }, "projects": { "type": "array", "items": { "$ref": "#/definitions/forms.ProjectOpenAPI" } }, "providers": { "type": "array", "items": { "$ref": "#/definitions/forms.Provider" } }, "services": { "description": "The Identifier of TiDB Cloud services consists of 3 levels. For example, \"service\": \"TiDB Dedicated - Node Compute - TiFlash\" consists of the following 3 levels.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } } } }, "forms.TrendsFilter": { "type": "object", "properties": { "clusters": { "description": "A list of cluster IDs to include in the query.", "type": "array", "items": { "type": "string" } }, "customers": { "description": "\"A list of customer IDs to include in the query.", "type": "array", "items": { "type": "string" } }, "projects": { "description": "A list of project IDs to include in the query.", "type": "array", "items": { "type": "string" } }, "providers": { "description": "A list of providers to include in the query.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerProvider" } }, "services": { "description": "A list of TiDB Cloud services to include in the query.", "type": "array", "items": { "$ref": "#/definitions/forms.CostExplorerService" } }, "timeRange": { "description": "The time period for the query.", "allOf": [ { "$ref": "#/definitions/forms.TimeRange" } ] } } }, "forms.TrendsInput": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/forms.TrendsFilter" }, "groups": { "$ref": "#/definitions/forms.Groups" } } }, "forms.Trigger": { "type": "object", "properties": { "is_send_now": { "type": "boolean" }, "is_test": { "type": "boolean" }, "operator": { "type": "string" }, "payload": { "type": "object", "additionalProperties": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "schedule_time": { "type": "string" }, "scope_type": { "type": "string" }, "target_id_list": { "type": "array", "items": { "type": "string" } }, "tenant_id": { "type": "integer" }, "transaction_id": { "type": "string" }, "trigger_id": { "type": "string" }, "worker_flow_id": { "type": "string" } } }, "forms.UnitByGroup": { "type": "object", "properties": { "beta_end_time": { "type": "string" }, "group_id": { "type": "integer" }, "group_labels": { "type": "object", "additionalProperties": { "type": "string" } }, "price": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "unit_key_parameters": { "type": "object", "additionalProperties": { "type": "string" } } } }, "forms.UnitCSVImportResult": { "type": "object", "properties": { "imported_rows": { "type": "integer" } } }, "forms.UnitCosts": { "type": "object", "properties": { "binded_package_id": { "type": "integer" }, "consumed_source": { "type": "string" }, "cost": { "type": "integer" }, "cost_id": { "type": "string" }, "cost_time_stamp": { "type": "integer" }, "discount": { "type": "string" }, "internal": { "type": "boolean" }, "invoice_id": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "package_id": { "type": "integer" }, "package_version": { "type": "integer" }, "price": { "type": "string" }, "raw_price": { "type": "string" }, "unit": { "type": "string" } } }, "forms.UnitCostsInput": { "type": "object", "properties": { "cost": { "type": "integer" }, "cost_id": { "description": "optional", "type": "string" }, "cost_time_stamp": { "type": "integer" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "unit": { "type": "string" } } }, "forms.UnitFilter": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "filter_id": { "type": "integer" }, "general": { "type": "boolean" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "provider": { "type": "string" }, "region": { "type": "string" }, "type_id": { "description": "this field is a deprecated", "type": "integer" }, "unit_key_pattern": { "type": "string" } } }, "forms.UnitFilterNode": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/forms.UnitFilterNode" } }, "description": { "type": "string" }, "filter_id": { "type": "integer" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "type_id": { "description": "this field is a deprecated", "type": "integer" } } }, "forms.UnitFilterSlim": { "type": "object", "properties": { "description": { "type": "string" }, "filter_id": { "type": "integer" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "type_id": { "description": "this field is a deprecated", "type": "integer" } } }, "forms.UnitInfo": { "type": "object", "properties": { "beta_end_time": { "description": "optional", "type": "string" }, "beta_internal": { "description": "optional", "type": "boolean" }, "category": { "description": "optional", "type": "string" }, "commodity_code": { "description": "optional", "type": "string" }, "description": { "type": "string" }, "edition_code": { "description": "optional", "type": "string" }, "group_id": { "description": "optional", "type": "integer" }, "measure_unit": { "description": "optional", "type": "string" }, "price": { "description": "optional", "type": "string" }, "price_expression": { "description": "optional", "type": "object", "additionalProperties": { "type": "string" } }, "price_type": { "description": "optional", "type": "string" }, "provider": { "description": "optional", "type": "string" }, "region": { "description": "optional", "type": "string" }, "sku_template_id": { "description": "optional", "type": "integer" }, "sku_type": { "description": "optional", "type": "string" }, "unit": { "type": "string", "minLength": 1 }, "unit_end_time": { "description": "optional", "type": "string" }, "version": { "description": "optional", "type": "integer" } } }, "forms.UnitPatch": { "type": "object", "properties": { "price": { "type": "string" }, "price_expression": { "type": "object", "additionalProperties": { "type": "string" } }, "price_type": { "type": "string" }, "unit": { "type": "string" } } }, "forms.UnitPrice": { "type": "object", "properties": { "multiple_factor_label": { "type": "string" }, "multiple_factor_threshold": { "type": "integer" }, "price": { "type": "string" }, "unit": { "type": "string" } } }, "forms.UnitPrices": { "type": "object", "additionalProperties": { "$ref": "#/definitions/forms.UnitPrice" } }, "forms.UsageDetails": { "type": "object", "properties": { "amount": { "type": "string" }, "billable_cost": { "type": "string" }, "billed_date": { "type": "string" }, "cluster_name": { "type": "string" }, "credit_usage": { "type": "string" }, "discount_cost": { "type": "string" }, "project_name": { "type": "string" }, "service": { "type": "string" } } }, "forms.User": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "role": { "type": "string" }, "user_id": { "type": "integer" } } }, "forms.Variable": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "forms.WorkFlows": { "type": "object", "properties": { "count": { "type": "integer" }, "page_query": { "$ref": "#/definitions/forms.PageQuery" }, "work_flows": { "type": "array", "items": { "$ref": "#/definitions/forms.Workflow" } } } }, "forms.WorkerSubTaskAction": { "type": "object", "properties": { "action": { "type": "string" }, "run_time": { "type": "string" }, "tenant_id": { "type": "integer" } } }, "forms.WorkerTaskAction": { "type": "object", "properties": { "action": { "type": "string" }, "run_time": { "type": "string" } } }, "forms.Workflow": { "type": "object", "properties": { "created_at": { "type": "string" }, "creator_id": { "type": "string" }, "in_app_content": { "type": "string" }, "notification_group": { "type": "string" }, "subject": { "type": "string" }, "trigger_id": { "type": "string" }, "updated_at": { "type": "string" }, "variables": { "type": "array", "items": { "$ref": "#/definitions/forms.Variable" } }, "worker_flow_id": { "type": "string" }, "worker_flow_name": { "type": "string" } } } } }