{ "swagger": "2.0", "info": { "description": "This is a billing system server for TiDB Cloud Partners.", "title": "Partner OPENAPI", "contact": {}, "version": "v1beta1" }, "host": "tcpn.tidbapi.com", "basePath": "/v1beta1/partners", "paths": { "/billingProfile": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/billingProfile'" } ], "description": "This endpoint retrieves the billing profile for an organization.", "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Get organization billing profile", "operationId": "Billing_GetOrgBillingProfile", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } } }, "patch": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request PATCH \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/billingProfile' \\\n --data '{\n \"billingEmail\": \"{email}\",\n \"city\": \"{city}\",\n \"companyName\": \"{companyName}\",\n \"countryCode\": \"{countryCode}\",\n \"line1\": \"{line1}\",\n \"line2\": \"{line2}\",\n \"postalCode\": \"{postalCode}\",\n \"state\": \"{state}\",\n \"taxId\": \"{taxId}\",\n \"taxIdType\": \"{taxIdType}\"\n }'" } ], "description": "This endpoint updates the billing profile for an organization.", "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Update organization billing profile", "operationId": "Billing_UpdateOrgBillingProfile", "parameters": [ { "description": "billing profile", "name": "billingProfile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BillingProfileForOpenAPI" } } } } }, "/bills/{billedMonth}": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/bills/{YYYY-MM}'" } ], "description": "This endpoint retrieves the bill for the given month of a specific organization. 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": [ "Billing" ], "summary": "Get organization monthly bills", "operationId": "Billing_GetPartnerBills", "parameters": [ { "type": "string", "description": "The month for which to retrieve the bill, in the format of `YYYY-MM`. For example, `2024-08`.", "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" } } } } }, "/billsCostExplorer": { "post": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request POST \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/billsCostExplorer' \\\n --data '{\"filter\": {}, {groups\": {\"groupBy\": [\"service\"],\"timeGranularity\": \"day\"}'" } ], "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": [ "Billing" ], "summary": "Get the usage details according to a cost explorer query", "operationId": "Billing_PartnerTrendsOpenAPI", "parameters": [ { "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" } } } } }, "/billsCostExplorerArgs": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/billsCostExplorerArgs'" } ], "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": [ "Billing" ], "summary": "Get basic information of a specific organization, which contains the key information to execute a cost explorer query", "operationId": "Billing_GetPartnerTrendsArgs", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerTrendsArgs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } } }, "/billsDetails/{billedMonth}": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/billsDetails/{billedMonth}'" } ], "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": [ "Billing" ], "summary": "Get the monthly bill of the organization with daily usage details", "operationId": "Billing_GetPartnerBillsDetails", "parameters": [ { "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" } } } } }, "/boundSupportPlans": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/boundSupportPlans'" } ], "description": "This endpoint retrieves the active support plan for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Support" ], "summary": "Get organization active support plan", "operationId": "Billing_GetOrgActiveSupportPlanForOpenAPI", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OrgSupportPlanForOpenAPI" } } } } }, "/budgets": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/budgets'" } ], "description": "This endpoint retrieves a list of budgets for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "List organization budgets", "operationId": "Billing_ListOrgBudgets", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } } }, "post": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request POST \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/budgets' \\\n --data ' {\n \"applyCredits\": true,\n \"applyDiscounts\": true,\n \"bizType\": \"budget_alert\",\n \"budgetInterval\": \"monthly\",\n \"costType\": \"total\",\n \"enableEmailNotification\": true,\n \"limit\": \"100\",\n \"name\": \"myBudget\",\n \"rangId\": \"1\",\n \"rangeType\": \"tenant\",\n \"thresholds\": [\n {\n \"proportion\": \"0.3\"\n }\n ]\n }'" } ], "description": "This endpoint creates a new budget for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Create a budget for an organization", "operationId": "Billing_CreateBudget", "parameters": [ { "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": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/budgets/{budgetId}'" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Get a budget", "operationId": "Billing_GetBudget", "parameters": [ { "type": "string", "description": "The ID of the budget.", "name": "budgetId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.BudgetForOpenAPI" } } } }, "delete": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request DELETE \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/budgets/{budgetId}'" } ], "description": "This endpoint deletes a specific budget for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Delete a budget for an organization", "operationId": "Billing_DeleteBudget", "parameters": [ { "type": "string", "description": "The ID of the budget to delete. You can get the budget ID from the response of [List organization budgets](#tag/Billing/operation/Billing_ListOrgBudgets).", "name": "budgetId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.OKType" } } } }, "patch": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request PATCH \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/budgets/{budgetId}' \\\n --data ' {\n \"applyCredits\": true,\n \"applyDiscounts\": true,\n \"bizType\": \"budget_alert\",\n \"budgetInterval\": \"monthly\",\n \"costType\": \"total\",\n \"enableEmailNotification\": true,\n \"limit\": \"100\",\n \"name\": \"myBudget\",\n \"rangId\": \"1\",\n \"rangeType\": \"tenant\",\n \"thresholds\": [\n {\n \"proportion\": \"0.3\"\n }\n ]\n }'" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Update a budget for an organization", "operationId": "Billing_UpdateBudget", "parameters": [ { "type": "string", "description": "The ID of the budget to delete. You can get the budget ID from the response of [List organization budgets](#tag/Billing/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" } } } } }, "/credits": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/credits'" } ], "description": "This endpoint retrieves a list of credits for an organization.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "List credits for an organization", "operationId": "Billing_ListCredits", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.CreditsForOpenAPI" } } } } } }, "/discounts": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/discounts'" } ], "description": "This endpoint retrieves a list of discounts available for an organization.", "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "List discounts for an organization", "operationId": "Billing_ListDiscounts", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.DiscountForOpenAPI" } } } } } }, "/partnerConfigs": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/partnerConfigs'" } ], "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", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PartnerConfigs" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/billing_errors.BaseError" } } } }, "patch": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/partnerConfigs' \\\n --data '{\"enableBillsView\": true}'" } ], "description": "This endpoint retrieves the partner configuration for a specific Partner.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Partner" ], "summary": "Update the Partner configurations for a Partner", "operationId": "Billing_UpdatePartnerConfigs", "parameters": [ { "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" } } } } }, "/payments": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/payments'" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Billing" ], "summary": "Get active payment method", "operationId": "Billing_GetPartnerPayment", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/forms.PaymentForOpenAPI" } } } } }, "/publicSupportPlans": { "get": { "x-code-samples": [ { "lang": "curl", "source": "curl --digest \\\n --user 'YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY' \\\n --request GET \\\n --url 'https://tcpn.tidbapi.com/v1beta1/partners/publicSupportPlans'" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Support" ], "summary": "List public support plans", "operationId": "Billing_ListPublicSupportPlans", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/forms.SupportPlanForOpenAPI" } } } } } } }, "definitions": { "billing_errors.BaseError": { "type": "object", "properties": { "code": { "type": "string" }, "error": {}, "msgPrefix": { "type": "string" }, "status": { "type": "integer" } } }, "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.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.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.ClusterOpenAPI": { "type": "object", "properties": { "ProjectID": { "type": "string", "example": "0" }, "id": { "type": "string", "example": "0" }, "name": { "type": "string" }, "regionName": { "type": "string" }, "status": { "type": "string" } } }, "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.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.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" }, "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" }, "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.CreditsState": { "type": "string", "enum": [ "active", "inactive", "before_active" ], "x-enum-varnames": [ "CreditsState_Active", "CreditsState_Inactive", "CreditsState_BeforeActive" ] }, "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.DiscountForOpenAPI": { "type": "object", "properties": { "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%" }, "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.DiscountState": { "type": "string", "enum": [ "valid", "expired", "reclaimed", "invalid" ], "x-enum-varnames": [ "DiscountState_Valid", "DiscountState_Expired", "DiscountState_Reclaimed", "DiscountState_Invalid" ] }, "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 Cloud Starter, or TiDB Cloud Essential)\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.OKType": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } }, "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.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.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.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.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.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.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.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.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.SupportPlanLevel": { "type": "string", "enum": [ "Basic", "Standard", "Enterprise", "Premium" ], "x-enum-varnames": [ "SupportPlanLevel_Basic", "SupportPlanLevel_Standard", "SupportPlanLevel_Enterprise", "SupportPlanLevel_Premium" ] }, "forms.SupportPlanType": { "type": "string", "enum": [ "fixed_price", "percentage_price" ], "x-enum-varnames": [ "SupportPlanType_FixedPrice", "SupportPlanType_PercentagePrice" ] }, "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.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" } } } } }