{ "swagger": "2.0", "info": { "version": "2018-11-01-preview", "title": "BillingManagementClient", "description": "Billing client provides access to billing resources for Azure subscriptions." }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/providers/Microsoft.Billing/billingAccounts": { "get": { "tags": [ "BillingAccounts" ], "x-ms-examples": { "BillingAccountsList": { "$ref": "./examples/BillingAccountsList.json" }, "BillingAccountsListWithExpand": { "$ref": "./examples/BillingAccountsListWithExpand.json" }, "BillingAccountsListWithExpandForEnrollmentDetails": { "$ref": "./examples/BillingAccountsListWithExpandForEnrollmentDetails.json" } }, "operationId": "BillingAccounts_List", "description": "Lists all billing accounts for which a user has access.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "name": "$expand", "description": "May be used to expand the invoiceSections and billingProfiles.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}": { "get": { "tags": [ "BillingAccounts" ], "x-ms-examples": { "BillingAccounts": { "$ref": "./examples/BillingAccount.json" }, "BillingAccountWithExpand": { "$ref": "./examples/BillingAccountWithExpand.json" } }, "operationId": "BillingAccounts_Get", "description": "Get the billing account by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the invoiceSections and billingProfiles.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "BillingAccounts" ], "operationId": "BillingAccounts_Update", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "description": "The operation to update a billing account.", "x-ms-examples": { "UpdateBillingAccount": { "$ref": "./examples/UpdateBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingAccountUpdateProperties" }, "description": "Parameters supplied to the update billing account operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingAccount" } }, "202": { "description": "Accepted. Billing account update is in progress." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods": { "get": { "tags": [ "PaymentMethods" ], "operationId": "PaymentMethods_ListByBillingAccountName", "description": "Lists the Payment Methods by billing account Id.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/billing/2018-11-01-preview/paymentmethods" }, "x-ms-examples": { "PaymentMethodsListByBillingAccount": { "$ref": "./examples/PaymentMethodsListByBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/PaymentMethodsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/validateAddress": { "post": { "tags": [ "ValidateAddress" ], "x-ms-examples": { "ValidateAddressValid": { "$ref": "./examples/ValidateAddressValid.json" }, "ValidateAddressInvalid": { "$ref": "./examples/ValidateAddressInvalid.json" } }, "operationId": "Addresses_Validate", "description": "Validates the address.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "name": "address", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Address" } } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ValidateAddressResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": { "get": { "tags": [ "AvailableBalances" ], "operationId": "AvailableBalances_GetByBillingProfile", "description": "The latest available credit balance for a given billingAccountName and billingProfileName.", "x-ms-examples": { "AvailableBalanceByBillingProfile": { "$ref": "./examples/AvailableBalanceByBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/AvailableBalance" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethods": { "get": { "tags": [ "PaymentMethods" ], "operationId": "PaymentMethods_ListByBillingProfileName", "description": "Lists the Payment Methods by billing profile Id.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "PaymentMethodsListByBillingProfile": { "$ref": "./examples/PaymentMethodsListByBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/PaymentMethodsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { "get": { "tags": [ "BillingProfiles" ], "x-ms-examples": { "BillingProfilesListByBillingAccountName": { "$ref": "./examples/BillingProfilesListByBillingAccountName.json" } }, "operationId": "BillingProfiles_ListByBillingAccountName", "description": "Lists all billing profiles for a user which that user has access to.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the invoiceSections.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingProfileListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "tags": [ "BillingProfiles" ], "operationId": "BillingProfiles_Create", "x-ms-long-running-operation": true, "description": "The operation to create a BillingProfile.", "x-ms-examples": { "CreateBillingProfile": { "$ref": "./examples/CreateBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingProfileCreationParameters" }, "description": "Parameters supplied to the Create BillingProfile operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingProfile" } }, "202": { "description": "Accepted", "headers": { "Location": { "description": "Location URI to poll for result", "type": "string" }, "Retry-After": { "description": "Recommends the retryable time after receiving this.", "type": "integer", "format": "int32" }, "Azure-AsyncOperation": { "description": "URI to poll for the operation status", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": { "get": { "tags": [ "BillingProfiles" ], "x-ms-examples": { "BillingProfile": { "$ref": "./examples/BillingProfile.json" } }, "operationId": "BillingProfiles_Get", "description": "Get the billing profile by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "name": "$expand", "description": "May be used to expand the invoiceSections.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "BillingProfiles" ], "operationId": "BillingProfiles_Update", "x-ms-long-running-operation": true, "description": "The operation to update a billing profile.", "x-ms-examples": { "UpdateBillingProfile": { "$ref": "./examples/UpdateBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingProfile" }, "description": "Parameters supplied to the update billing profile operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingProfile" } }, "202": { "description": "Accepted. Billing profile update is in progress.", "headers": { "Location": { "description": "GET this URL to retrieve the status of the asynchronous operation.", "type": "string" }, "Retry-After": { "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers": { "get": { "tags": [ "Customers" ], "x-ms-examples": { "CustomersListByBillingAccountName": { "$ref": "./examples/CustomersListByBillingAccountName.json" } }, "operationId": "Customers_ListByBillingAccountName", "description": "Lists all customers which the current user can work with on-behalf of a partner.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$filter", "description": "May be used to filter using hasPermission('{permissionId}') to only return customers for which the caller has the specified permission.", "in": "query", "required": false, "type": "string" }, { "name": "$skiptoken", "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/CustomerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}": { "get": { "tags": [ "Customers" ], "x-ms-examples": { "Customer": { "$ref": "./examples/Customer.json" }, "CustomerWithExpand": { "$ref": "./examples/CustomerWithExpand.json" } }, "operationId": "Customers_Get", "description": "Get the customer by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/customerNameParameter" }, { "name": "$expand", "description": "May be used to expand enabledAzureSkus, resellers.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Customer" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections": { "get": { "tags": [ "InvoiceSections" ], "x-ms-examples": { "InvoiceSectionsListByBillingAccountName": { "$ref": "./examples/InvoiceSectionsListByBillingAccountName.json" }, "InvoiceSectionsListByBillingAccountNameWithExpand": { "$ref": "./examples/InvoiceSectionsListByBillingAccountNameWithExpand.json" } }, "operationId": "InvoiceSections_ListByBillingAccountName", "description": "Lists all invoice sections for which a user has access.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the billingProfiles.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSectionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "post": { "tags": [ "InvoiceSections" ], "operationId": "InvoiceSections_Create", "x-ms-long-running-operation": true, "description": "The operation to create a InvoiceSection.", "x-ms-examples": { "CreateInvoiceSection": { "$ref": "./examples/CreateInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InvoiceSectionCreationRequest" }, "description": "Parameters supplied to the Create InvoiceSection operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSection" } }, "202": { "description": "Accepted", "headers": { "Location": { "description": "Location URI to poll for result", "type": "string" }, "Retry-After": { "description": "Recommends the retryable time after receiving this.", "type": "integer", "format": "int32" }, "Azure-AsyncOperation": { "description": "URI to poll for the operation status", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": { "get": { "tags": [ "InvoiceSections" ], "x-ms-examples": { "InvoiceSectionsListByBillingProfileName": { "$ref": "./examples/InvoiceSectionsListByBillingProfileName.json" } }, "operationId": "InvoiceSections_ListByBillingProfileName", "description": "Lists all invoice sections under a billing profile for which a user has access.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSectionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": { "get": { "tags": [ "InvoiceSections" ], "x-ms-examples": { "InvoiceSectionsListByBillingAccountNameWithCreateSubPermission": { "$ref": "./examples/InvoiceSectionsListByBillingAccountNameWithCreateSubPermission.json" }, "InvoiceSectionsListByBillingAccountNameWithExpandAndCreateSubPermission": { "$ref": "./examples/InvoiceSectionsListByBillingAccountNameWithExpandAndCreateSubPermission.json" } }, "operationId": "InvoiceSections_ListByCreateSubscriptionPermission", "description": "Lists all invoiceSections with create subscription permission for a user.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the billingProfiles.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSectionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}": { "get": { "tags": [ "InvoiceSections" ], "x-ms-examples": { "InvoiceSection": { "$ref": "./examples/InvoiceSection.json" }, "InvoiceSectionWithExpand": { "$ref": "./examples/InvoiceSectionWithExpand.json" } }, "operationId": "InvoiceSections_Get", "description": "Get the InvoiceSection by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "name": "$expand", "description": "May be used to expand the billingProfiles.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "InvoiceSections" ], "operationId": "InvoiceSections_Update", "x-ms-long-running-operation": true, "description": "The operation to update a InvoiceSection.", "x-ms-examples": { "UpdateInvoiceSection": { "$ref": "./examples/UpdateInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InvoiceSection" }, "description": "Parameters supplied to the Create InvoiceSection operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSection" } }, "202": { "description": "Accepted. InvoiceSection update is in progress.", "headers": { "Location": { "description": "GET this URL to retrieve the status of the asynchronous operation.", "type": "string" }, "Retry-After": { "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments": { "get": { "tags": [ "Departments" ], "x-ms-examples": { "DepartmentsListByBillingAccountName": { "$ref": "./examples/DepartmentsListByBillingAccountName.json" }, "DepartmentsListByBillingAccountNameWithExpand": { "$ref": "./examples/DepartmentsListByBillingAccountNameWithExpand.json" } }, "operationId": "Departments_ListByBillingAccountName", "description": "Lists all departments for which a user has access.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the enrollmentAccounts.", "in": "query", "required": false, "type": "string" }, { "name": "$filter", "description": "The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/DepartmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}": { "get": { "tags": [ "Departments" ], "x-ms-examples": { "Department": { "$ref": "./examples/Department.json" }, "DepartmentWithExpand": { "$ref": "./examples/DepartmentWithExpand.json" } }, "operationId": "Departments_Get", "description": "Get the department by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/departmentNameParameter" }, { "name": "$expand", "description": "May be used to expand the enrollmentAccounts.", "in": "query", "required": false, "type": "string" }, { "name": "$filter", "description": "The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Department" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts": { "get": { "tags": [ "EnrollmentAccounts" ], "x-ms-examples": { "EnrollmentAccountsListByBillingAccountName": { "$ref": "./examples/EnrollmentAccountsListByBillingAccountName.json" }, "EnrollmentAccountsListByBillingAccountNameWithExpand": { "$ref": "./examples/EnrollmentAccountsListByBillingAccountNameWithExpand.json" } }, "operationId": "EnrollmentAccounts_ListByBillingAccountName", "description": "Lists all Enrollment Accounts for which a user has access.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the department.", "in": "query", "required": false, "type": "string" }, { "name": "$filter", "description": "The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/EnrollmentAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}": { "get": { "tags": [ "EnrollmentAccounts" ], "x-ms-examples": { "EnrollmentAccount": { "$ref": "./examples/EnrollmentAccount.json" }, "EnrollmentAccountWithExpand": { "$ref": "./examples/EnrollmentAccountWithExpand.json" } }, "operationId": "EnrollmentAccounts_GetByEnrollmentAccountId", "description": "Get the enrollment account by id.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/enrollmentAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the Department.", "in": "query", "required": false, "type": "string" }, { "name": "$filter", "description": "The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/EnrollmentAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices": { "get": { "tags": [ "Invoices" ], "x-ms-examples": { "BillingAccountInvoicesList": { "$ref": "./examples/BillingAccountInvoicesList.json" } }, "operationId": "Invoices_ListByBillingAccountName", "description": "List of invoices for a billing account.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "periodStartDate", "description": "Invoice period start date.", "in": "query", "required": true, "type": "string" }, { "name": "periodEndDate", "description": "Invoice period end date.", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/pricesheet/default/download": { "post": { "tags": [ "PriceSheet" ], "x-ms-examples": { "PricesheetDownload": { "$ref": "./examples/PricesheetDownload.json" } }, "operationId": "PriceSheet_Download", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "description": "Download price sheet for an invoice.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "Azure Billing Account ID.", "required": true, "type": "string" }, { "name": "invoiceName", "description": "The name of an invoice resource.", "in": "path", "required": true, "type": "string" } ], "responses": { "202": { "description": "Accepted.", "headers": { "Location": { "description": "GET this URL to retrieve the status of the asynchronous operation.", "type": "string" }, "Retry-After": { "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", "type": "string" }, "Azure-AsyncOperation": { "description": "To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field.", "type": "string" }, "OData-EntityId": { "description": "The operation entity Id GUID.", "type": "string" } } }, "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/DownloadUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": { "get": { "tags": [ "Invoices" ], "x-ms-examples": { "InvoicesListByBillingProfile": { "$ref": "./examples/InvoicesListByBillingProfile.json" } }, "operationId": "Invoices_ListByBillingProfile", "description": "List of invoices for a billing profile.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "name": "periodStartDate", "description": "Invoice period start date.", "in": "query", "required": true, "type": "string" }, { "name": "periodEndDate", "description": "Invoice period end date.", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}": { "get": { "tags": [ "Invoices" ], "x-ms-examples": { "Invoice": { "$ref": "./examples/Invoice.json" } }, "operationId": "Invoices_Get", "description": "Get the invoice by name.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/invoiceNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/InvoiceSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_ListByBillingAccountName", "description": "Lists billing subscriptions by billing account name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscriptionsListByBillingAccount": { "$ref": "./examples/BillingSubscriptionsListByBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_ListByBillingProfileName", "description": "Lists billing subscriptions by billing profile name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscriptionsListByBillingProfile": { "$ref": "./examples/BillingSubscriptionsListByBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_ListByCustomerName", "description": "Lists billing subscription by customer name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscriptionsListByCustomer": { "$ref": "./examples/BillingSubscriptionsListByCustomer.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/customerNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions/{billingSubscriptionName}": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_GetByCustomerName", "description": "Get a single billing subscription by name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscriptionByCustomerName": { "$ref": "./examples/BillingSubscriptionByCustomerName.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/customerNameParameter" }, { "$ref": "#/parameters/billingSubscriptionNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_ListByInvoiceSectionName", "description": "Lists billing subscription by invoice section name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscriptionsListByInvoiceSection": { "$ref": "./examples/BillingSubscriptionsListByInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}": { "get": { "tags": [ "BillingSubscriptions" ], "operationId": "BillingSubscriptions_Get", "description": "Get a single billing subscription by name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingSubscription": { "$ref": "./examples/BillingSubscription.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingSubscriptionNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingSubscriptionSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer": { "post": { "description": "Transfers the subscription from one invoice section to another within a billing account.", "operationId": "BillingSubscriptions_Transfer", "x-ms-long-running-operation": true, "x-ms-examples": { "TransferBillingSubscription": { "$ref": "./examples/TransferBillingSubscription.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingSubscriptionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties" }, "description": "Parameters supplied to the Transfer Billing Subscription operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/TransferBillingSubscriptionResult" } }, "202": { "description": "Accepted. Billing Subscription transfer is in progress.", "headers": { "Location": { "description": "Location URI to poll for result.", "type": "string" }, "Retry-After": { "description": "Recommends the retryable time after receiving this.", "type": "integer", "format": "int32" }, "Azure-AsyncOperation": { "description": "URI to poll for the operation status", "type": "string" } } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/validateTransferEligibility": { "post": { "x-ms-examples": { "SubscriptionTransferValidateSuccess": { "$ref": "./examples/ValidateSubscriptionTransferSuccess.json" }, "SubscriptionTransferValidateFailure": { "$ref": "./examples/ValidateSubscriptionTransferFailure.json" } }, "operationId": "BillingSubscriptions_ValidateTransfer", "description": "Validates the transfer of billing subscriptions across invoice sections.", "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingSubscriptionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties" }, "description": "Parameters supplied to the Transfer Billing Subscription operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products": { "get": { "tags": [ "Products" ], "operationId": "Products_ListByBillingAccountName", "description": "Lists products by billing account name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "ProductsListByBillingAccount": { "$ref": "./examples/ProductsListByBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "$filter", "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ProductsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products": { "get": { "tags": [ "Products" ], "operationId": "Products_ListByInvoiceSectionName", "description": "Lists products by invoice section name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "ProductsListByInvoiceSection": { "$ref": "./examples/ProductsListByInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "$filter", "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ProductsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}": { "get": { "tags": [ "Products" ], "operationId": "Products_Get", "description": "Get a single product by name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "Product": { "$ref": "./examples/Product.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/productNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ProductSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/transfer": { "post": { "tags": [ "Products" ], "operationId": "Products_Transfer", "description": "The operation to transfer a Product to another invoice section.", "x-ms-examples": { "TransferProduct": { "$ref": "./examples/TransferProduct.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/productNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TransferProductRequestProperties" }, "description": "Parameters supplied to the Transfer Product operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ProductSummary" } }, "202": { "description": "Accepted", "headers": { "Location": { "description": "Location URI to poll for result", "type": "string" }, "Retry-After": { "description": "Recommends the retryable time after receiving this.", "type": "integer", "format": "int32" }, "Azure-AsyncOperation": { "description": "URI to poll for the operation status", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/validateTransferEligibility": { "post": { "x-ms-examples": { "SubscriptionTransferValidateSuccess": { "$ref": "./examples/ValidateProductTransferSuccess.json" }, "SubscriptionTransferValidateFailure": { "$ref": "./examples/ValidateProductTransferFailure.json" } }, "operationId": "Products_ValidateTransfer", "description": "Validates the transfer of products across invoice sections.", "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/productNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TransferProductRequestProperties" }, "description": "Parameters supplied to the Transfer Products operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/ValidateProductTransferEligibilityResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "Transactions_ListByBillingAccountName", "description": "Lists the transactions by billing account name for given start and end date.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "TransactionsListByBillingAccount": { "$ref": "./examples/TransactionsListByBillingAccount.json" }, "ReservationTransactionsListByBillingAccount": { "$ref": "./examples/ReservationTransactionsListByBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "startDate", "in": "query", "description": "Start date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End date", "required": true, "type": "string" }, { "name": "$filter", "description": "May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/TransactionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "Transactions_ListByBillingProfileName", "description": "Lists the transactions by billing profile name for given start date and end date.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "TransactionsListByBillingProfile": { "$ref": "./examples/TransactionsListByBillingProfile.json" }, "ReservationTransactionsListByBillingProfile": { "$ref": "./examples/ReservationTransactionsListByBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "startDate", "in": "query", "description": "Start date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End date", "required": true, "type": "string" }, { "name": "$filter", "description": "May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/TransactionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "Transactions_ListByCustomerName", "description": "Lists the transactions by invoice section name for given start date and end date.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "TransactionsListByCustomer": { "$ref": "./examples/TransactionsListByCustomer.json" }, "ReservationTransactionsListByCustomer": { "$ref": "./examples/ReservationTransactionsListByCustomer.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/customerNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "startDate", "in": "query", "description": "Start date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End date", "required": true, "type": "string" }, { "name": "$filter", "description": "May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/TransactionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "Transactions_ListByInvoiceSectionName", "description": "Lists the transactions by invoice section name for given start date and end date.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "TransactionsListByInvoiceSection": { "$ref": "./examples/TransactionsListByInvoiceSection.json" }, "ReservationTransactionsListByInvoiceSection": { "$ref": "./examples/ReservationTransactionsListByInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "startDate", "in": "query", "description": "Start date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End date", "required": true, "type": "string" }, { "name": "$filter", "description": "May be used to filter by transaction kind. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/TransactionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": { "get": { "tags": [ "Policies" ], "operationId": "Policies_GetByBillingProfileName", "description": "The policy for a given billing account name and billing profile name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "PolicyByBillingProfile": { "$ref": "./examples/Policy.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Policy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "Policies" ], "operationId": "Policies_Update", "description": "The operation to update a policy.", "x-ms-examples": { "UpdateBillingProfile": { "$ref": "./examples/UpdatePolicy.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Policy" }, "description": "Parameters supplied to the update policy operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Policy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty": { "get": { "tags": [ "BillingProperties" ], "operationId": "BillingProperty_Get", "description": "Get billing property by subscription Id.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "BillingProperty": { "$ref": "./examples/BillingProperty.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingProperty" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/updateAutoRenew": { "post": { "tags": [ "Products" ], "operationId": "Products_UpdateAutoRenewByBillingAccountName", "description": "Cancel auto renew for product by product id and billing account name", "x-ms-examples": { "ProductsCancelByBillingAccount": { "$ref": "./examples/ProductCancelByBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/productNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/updateAutoRenewRequestParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/UpdateAutoRenewOperationSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/updateAutoRenew": { "post": { "tags": [ "Products" ], "operationId": "Products_UpdateAutoRenewByInvoiceSectionName", "description": "Cancel auto renew for product by product id and invoice section name", "x-ms-examples": { "CancelProductForInvoiceSection": { "$ref": "./examples/ProductCancelForInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/productNameParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/updateAutoRenewRequestParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/UpdateAutoRenewOperationSummary" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/elevate": { "post": { "tags": [ "InvoiceSections" ], "description": "Elevates the caller's access to match their billing profile access.", "operationId": "InvoiceSections_ElevateToBillingProfile", "x-ms-examples": { "Elevate": { "$ref": "./examples/ElevateInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" } ], "responses": { "204": { "description": "Elevated the caller's access to the invoice section." }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/initiateTransfer": { "post": { "tags": [ "Transfers" ], "description": "Initiates the request to transfer the legacy subscriptions or RIs.", "operationId": "Transfers_Initiate", "x-ms-examples": { "InitiateTransfer": { "$ref": "./examples/InitiateTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/initiateTransferRequestParameter" } ], "responses": { "200": { "description": "Initiated transfer details.", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}": { "get": { "tags": [ "Transfers" ], "description": "Gets the transfer details for given transfer Id.", "operationId": "Transfers_Get", "x-ms-examples": { "TransferGet": { "$ref": "./examples/GetTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/transferNameParameter" } ], "responses": { "200": { "description": "Details of transfer.", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Transfers" ], "description": "Cancels the transfer for given transfer Id.", "operationId": "Transfers_Cancel", "x-ms-examples": { "TransferCancel": { "$ref": "./examples/CancelTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/transferNameParameter" } ], "responses": { "200": { "description": "Details of canceled transfer.", "schema": { "$ref": "#/definitions/TransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers": { "get": { "tags": [ "Transfers" ], "description": "Lists all transfer's details initiated from given invoice section.", "operationId": "Transfers_List", "x-ms-examples": { "TransfersList": { "$ref": "./examples/ListTransfers.json" } }, "parameters": [ { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" } ], "responses": { "200": { "description": "List of transfers initiated from this invoice section.", "schema": { "$ref": "#/definitions/TransferDetailsListResult" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/transfers/{transferName}/acceptTransfer": { "post": { "tags": [ "RecipientTransfers" ], "summary": "Accepts the transfer with given transfer Id.", "operationId": "RecipientTransfers_Accept", "x-ms-examples": { "AcceptTransfer": { "$ref": "./examples/AcceptTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/transferNameParameter" }, { "$ref": "#/parameters/acceptTransferRequestParameter" } ], "responses": { "200": { "description": "Details of the accepted transfer.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/transfers/{transferName}/declineTransfer": { "post": { "tags": [ "RecipientTransfers" ], "summary": "Declines the transfer with given transfer Id.", "operationId": "RecipientTransfers_Decline", "x-ms-examples": { "DeclineTransfer": { "$ref": "./examples/DeclineTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/transferNameParameter" } ], "responses": { "200": { "description": "Details of the declined transfer.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/transfers/{transferName}/": { "get": { "tags": [ "RecipientTransfers" ], "summary": "Gets the transfer with given transfer Id.", "operationId": "RecipientTransfers_Get", "x-ms-examples": { "RecipientTransferGet": { "$ref": "./examples/GetRecipientTransfer.json" } }, "parameters": [ { "$ref": "#/parameters/transferNameParameter" } ], "responses": { "200": { "description": "Details of the transfers with given Id.", "schema": { "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/transfers": { "get": { "tags": [ "RecipientTransfers" ], "summary": "Lists the transfers received by caller.", "operationId": "RecipientTransfers_List", "x-ms-examples": { "RecipientTransfersList": { "$ref": "./examples/ListRecipientTransfers.json" } }, "responses": { "200": { "description": "List of transfers received by caller.", "schema": { "$ref": "#/definitions/RecipientTransferDetailsListResult" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/operations": { "get": { "tags": [ "Operations" ], "operationId": "Operations_List", "description": "Lists all of the available billing REST API operations.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingPermissions": { "get": { "tags": [ "BillingPermissions" ], "x-ms-examples": { "BillingAccountPermissionsList": { "$ref": "./examples/BillingAccountPermissionsList.json" } }, "operationId": "BillingPermissions_ListByBillingAccount", "description": "Lists all billing permissions for the caller under a billing account.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingPermissionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/providers/Microsoft.Billing/billingPermissions": { "get": { "tags": [ "BillingPermissions" ], "x-ms-examples": { "CustomerPermissionsList": { "$ref": "./examples/CustomerPermissionsList.json" } }, "operationId": "BillingPermissions_ListByCustomers", "description": "Lists all billing permissions for the caller under customer.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/customerNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingPermissionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingPermissions": { "get": { "tags": [ "BillingPermissions" ], "x-ms-examples": { "InvoiceSectionPermissionsList": { "$ref": "./examples/InvoiceSectionPermissionsList.json" } }, "operationId": "BillingPermissions_ListByInvoiceSections", "description": "Lists all billing permissions for the caller under invoice section.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingPermissionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingPermissions": { "get": { "tags": [ "BillingPermissions" ], "x-ms-examples": { "BillingProfilePermissionsList": { "$ref": "./examples/BillingProfilePermissionsList.json" } }, "operationId": "BillingPermissions_ListByBillingProfile", "description": "Lists all billingPermissions for the caller has for a billing account.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingPermissionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "BillingAccountRoleDefinition": { "$ref": "./examples/BillingAccountRoleDefinition.json" } }, "operationId": "BillingRoleDefinitions_GetByBillingAccountName", "description": "Gets the role definition for a role", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingRoleDefinitionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "InvoiceSectionRoleDefinition": { "$ref": "./examples/InvoiceSectionRoleDefinition.json" } }, "operationId": "BillingRoleDefinitions_GetByInvoiceSectionName", "description": "Gets the role definition for a role", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingRoleDefinitionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "BillingProfileRoleDefinition": { "$ref": "./examples/BillingProfileRoleDefinition.json" } }, "operationId": "BillingRoleDefinitions_GetByBillingProfileName", "description": "Gets the role definition for a role", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/billingRoleDefinitionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "BillingAccountRoleDefinitionsList": { "$ref": "./examples/BillingAccountRoleDefinitionsList.json" } }, "operationId": "BillingRoleDefinitions_ListByBillingAccountName", "description": "Lists the role definition for a billing account", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "InvoiceSectionRoleDefinitionsList": { "$ref": "./examples/InvoiceSectionRoleDefinitionsList.json" } }, "operationId": "BillingRoleDefinitions_ListByInvoiceSectionName", "description": "Lists the role definition for an invoice Section", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions": { "get": { "tags": [ "BillingRoleDefinitions" ], "x-ms-examples": { "BillingProfileRoleDefinitionsList": { "$ref": "./examples/BillingProfileRoleDefinitionsList.json" } }, "operationId": "BillingRoleDefinitions_ListByBillingProfileName", "description": "Lists the role definition for a Billing Profile", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleDefinitionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingAccountRoleAssignment": { "$ref": "./examples/BillingAccountRoleAssignment.json" } }, "operationId": "BillingRoleAssignments_GetByBillingAccount", "description": "Get the role assignment for the caller", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingAccountRoleAssignmentDelete": { "$ref": "./examples/BillingAccountRoleAssignmentDelete.json" } }, "operationId": "BillingRoleAssignments_DeleteByBillingAccountName", "description": "Delete the role assignment on this billing account", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "InvoiceSectionRoleAssignment": { "$ref": "./examples/InvoiceSectionRoleAssignment.json" } }, "operationId": "BillingRoleAssignments_GetByInvoiceSectionName", "description": "Get the role assignment for the caller on the invoice Section", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "InvoiceSectionRoleAssignmentDelete": { "$ref": "./examples/InvoiceSectionRoleAssignmentDelete.json" } }, "operationId": "BillingRoleAssignments_DeleteByInvoiceSectionName", "description": "Delete the role assignment on the invoice Section", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingProfileRoleAssignment": { "$ref": "./examples/BillingProfileRoleAssignment.json" } }, "operationId": "BillingRoleAssignments_GetByBillingProfileName", "description": "Get the role assignment for the caller on the Billing Profile", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingProfileRoleAssignmentDelete": { "$ref": "./examples/BillingProfileRoleAssignmentDelete.json" } }, "operationId": "BillingRoleAssignments_DeleteByBillingProfileName", "description": "Delete the role assignment on this Billing Profile", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingAccountRoleAssignmentList": { "$ref": "./examples/BillingAccountRoleAssignmentList.json" } }, "operationId": "BillingRoleAssignments_ListByBillingAccountName", "description": "Get the role assignments on the Billing Account", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/createBillingRoleAssignment": { "post": { "tags": [ "BillingRoleAssignments" ], "operationId": "BillingRoleAssignments_AddByBillingAccountName", "description": "The operation to add a role assignment to a billing account.", "x-ms-examples": { "AddRoleAssignmentToBillingAccount": { "$ref": "./examples/AddRoleAssignmentToBillingAccount.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentPayload" }, "description": "Parameters supplied to add a role assignment." } ], "responses": { "201": { "description": "Role assignment is successfully created", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "InvoiceSectionRoleAssignmentList": { "$ref": "./examples/InvoiceSectionRoleAssignmentList.json" } }, "operationId": "BillingRoleAssignments_ListByInvoiceSectionName", "description": "Get the role assignments on the invoice Section", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/createBillingRoleAssignment": { "post": { "tags": [ "BillingRoleAssignments" ], "operationId": "BillingRoleAssignments_AddByInvoiceSectionName", "description": "The operation to add a role assignment to a invoice Section.", "x-ms-examples": { "AddRoleAssignmentToInvoiceSection": { "$ref": "./examples/AddRoleAssignmentToInvoiceSection.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/invoiceSectionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentPayload" }, "description": "Parameters supplied to add a role assignment." } ], "responses": { "201": { "description": "Role assignment is successfully created", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments": { "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { "BillingProfileRoleAssignmentList": { "$ref": "./examples/BillingProfileRoleAssignmentList.json" } }, "operationId": "BillingRoleAssignments_ListByBillingProfileName", "description": "Get the role assignments on the Billing Profile", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/createBillingRoleAssignment": { "post": { "tags": [ "BillingRoleAssignments" ], "operationId": "BillingRoleAssignments_AddByBillingProfileName", "description": "The operation to add a role assignment to a billing profile.", "x-ms-examples": { "AddRoleAssignmentToBillingProfile": { "$ref": "./examples/AddRoleAssignmentToBillingProfile.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/billingProfileNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingRoleAssignmentPayload" }, "description": "Parameters supplied to add a role assignment." } ], "responses": { "201": { "description": "Role assignment is successfully created", "schema": { "$ref": "#/definitions/BillingRoleAssignmentListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { "get": { "tags": [ "Agreements" ], "x-ms-examples": { "AgreementsListByBillingAccountName": { "$ref": "./examples/AgreementsListByBillingAccountName.json" } }, "operationId": "Agreements_ListByBillingAccountName", "description": "Lists all agreements for a billing account.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "name": "$expand", "description": "May be used to expand the participants.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/AgreementListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { "get": { "tags": [ "Agreements" ], "x-ms-examples": { "AgreementByName": { "$ref": "./examples/AgreementByName.json" } }, "operationId": "Agreements_Get", "description": "Get the agreement by name.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" }, { "$ref": "#/parameters/agreementNameParameter" }, { "name": "$expand", "description": "May be used to expand the participants.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Agreement" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default": { "get": { "tags": [ "LineOfCredits" ], "x-ms-examples": { "LineOfCreditBySubscription": { "$ref": "./examples/LineOfCreditBySubscription.json" } }, "operationId": "LineOfCredits_Get", "description": "Get the current line of credit.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/LineOfCredit" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "LineOfCredits" ], "operationId": "LineOfCredits_Update", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "IncreaseLineOfCreditBySubscription": { "$ref": "./examples/IncreaseLineOfCreditBySubscription.json" } }, "description": "Increase the current line of credit.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LineOfCredit" }, "description": "Parameters supplied to the increase line of credit operation." } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/LineOfCredit" } }, "202": { "description": "Accepted. Line of credit increase is in progress.", "headers": { "Location": { "description": "Location URI to poll for result.", "type": "string" }, "Retry-After": { "description": "Recommends the retryable time after receiving this.", "type": "integer", "format": "int32" }, "Azure-AsyncOperation": { "description": "URI to poll for the operation status", "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } } }, "definitions": { "InitiateTransferRequest": { "type": "object", "description": "Request parameters to initiate transfer.", "properties": { "properties": { "description": "Request parameters to initiate transfer.", "x-ms-client-flatten": true, "$ref": "#/definitions/InitiateTransferProperties" } } }, "ValidateAddressResponse": { "type": "object", "description": "Result of the address validation", "properties": { "status": { "description": "status of the address validation.", "$ref": "#/definitions/AddressValidationStatus" }, "suggestedAddresses": { "description": "list of suggested addresses.", "type": "array", "items": { "$ref": "#/definitions/Address" } }, "validationMessage": { "description": "Validation error message.", "type": "string" } } }, "AddressValidationStatus": { "type": "string", "description": "Status of the address validation response.", "enum": [ "Valid", "Invalid" ], "x-ms-enum": { "name": "addressValidationStatus", "modelAsString": true } }, "InitiateTransferProperties": { "type": "object", "description": "Request parameters to initiate transfer.", "properties": { "billingProfileId": { "type": "string", "description": "Target Usage context for devTest subscriptions." }, "recipientEmailId": { "type": "string", "description": "Email Id of recipient for transfer." } } }, "AcceptTransferRequest": { "type": "object", "description": "Request parameters to accept transfer.", "properties": { "properties": { "description": "Request parameters to accept transfer.", "x-ms-client-flatten": true, "$ref": "#/definitions/AcceptTransferProperties" } } }, "AcceptTransferProperties": { "type": "object", "description": "Request parameters to accept transfer.", "properties": { "productDetails": { "description": "Request parameters to accept transfer.", "type": "array", "items": { "$ref": "#/definitions/ProductDetails" } } } }, "ProductDetails": { "type": "object", "description": "Details of the product to be transferred.", "properties": { "productType": { "description": "Type of the product to be transferred.", "$ref": "#/definitions/ProductType" }, "productId": { "type": "string", "description": "Id of product to be transferred." } } }, "ProductType": { "type": "string", "description": "Type of the product to be transferred.", "enum": [ "AzureSubscription", "AzureReservation" ], "x-ms-enum": { "name": "productType", "modelAsString": true } }, "TransferDetails": { "type": "object", "description": "Details of the transfer.", "properties": { "properties": { "description": "Details of the transfer.", "x-ms-client-flatten": true, "$ref": "#/definitions/TransferProperties" } } }, "RecipientTransferDetails": { "type": "object", "description": "Details of the transfer.", "properties": { "properties": { "description": "Details of the transfer.", "x-ms-client-flatten": true, "$ref": "#/definitions/RecipientTransferProperties" } } }, "DetailedTransferStatus": { "type": "object", "description": "Detailed transfer status.", "properties": { "productType": { "type": "string", "$ref": "#/definitions/ProductType", "readOnly": true, "description": "Type of product being transferred." }, "productId": { "type": "string", "readOnly": true, "description": "Id of product being transferred." }, "transferStatus": { "type": "string", "$ref": "#/definitions/ProductTransferStatus", "readOnly": true, "description": "Transfer status." }, "errorDetails": { "description": "Error details for transfer execution.", "$ref": "#/definitions/Error" } } }, "Error": { "description": "Error details for transfer execution.", "properties": { "errorCode": { "type": "string", "readOnly": true, "description": "Error code." }, "errorMessage": { "type": "string", "readOnly": true, "description": "Error message." } } }, "EligibleProductType": { "type": "string", "description": "Type of the products that can be transferred.", "enum": [ "DevTestAzureSubscription", "StandardAzureSubscription", "AzureReservation" ], "x-ms-enum": { "name": "eligibleProductType", "modelAsString": true } }, "TransferProperties": { "description": "Transfer details", "type": "object", "properties": { "creationTime": { "type": "string", "format": "date-time", "description": "Transfer creation time.", "readOnly": true }, "expirationTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Transfer expiration time." }, "invoiceSectionId": { "type": "string", "description": "Target invoice section Id.", "readOnly": true }, "billingAccountId": { "type": "string", "description": "Target billing account Id.", "readOnly": true }, "transferStatus": { "type": "string", "$ref": "#/definitions/TransferStatus", "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "readOnly": true, "description": "Email Id of recipient of transfer." }, "initiatorEmailId": { "type": "string", "readOnly": true, "description": "Email Id of initiator of transfer." }, "canceledBy": { "type": "string", "readOnly": true, "description": "Email Id who user canceled the transfer." }, "lastModifiedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Transfer last modification time." }, "detailedTransferStatus": { "type": "array", "readOnly": true, "description": "Detailed transfer status.", "items": { "$ref": "#/definitions/DetailedTransferStatus" } } } }, "RecipientTransferProperties": { "description": "Transfer Details.", "type": "object", "properties": { "creationTime": { "type": "string", "format": "date-time", "description": "Transfer creation time.", "readOnly": true }, "expirationTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Transfer expiration time." }, "allowedProductType": { "type": "array", "readOnly": true, "description": "Type of subscriptions that can be transferred.", "items": { "$ref": "#/definitions/EligibleProductType" } }, "transferStatus": { "type": "string", "$ref": "#/definitions/TransferStatus", "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "readOnly": true, "description": "Email Id of recipient of transfer." }, "initiatorEmailId": { "type": "string", "readOnly": true, "description": "Email Id of initiator of transfer." }, "canceledBy": { "type": "string", "readOnly": true, "description": "Email Id who user canceled the transfer." }, "lastModifiedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Transfer last modification time." }, "detailedTransferStatus": { "type": "array", "readOnly": true, "description": "Detailed transfer status.", "items": { "$ref": "#/definitions/DetailedTransferStatus" } } } }, "TransferStatus": { "type": "string", "description": "Possible transfer status.", "enum": [ "Pending", "InProgress", "Completed", "CompletedWithErrors", "Failed", "Canceled", "Declined" ], "x-ms-enum": { "name": "transferStatus", "modelAsString": true } }, "ProductTransferStatus": { "type": "string", "description": "Possible transfer status.", "enum": [ "NotStarted", "InProgress", "Completed", "Failed" ], "x-ms-enum": { "name": "productTransferStatus", "modelAsString": true } }, "RecipientTransferDetailsListResult": { "description": "Result of listing details of the transfer received by caller.", "properties": { "value": { "description": "The list of transfers received by caller.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/RecipientTransferDetails" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "TransferDetailsListResult": { "description": "Result of listing details of the transfer initiated by caller.", "properties": { "value": { "description": "The list of transfers initiated by caller.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/TransferDetails" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "TransferProductRequestProperties": { "description": "The properties of the product to initiate a transfer.", "properties": { "destinationInvoiceSectionId": { "type": "string", "description": "The destination invoice section id." }, "destinationBillingProfileId": { "type": "string", "description": "The destination billing profile id." } } }, "TransferBillingSubscriptionResult": { "type": "object", "description": "Request parameters to transfer billing subscription.", "properties": { "properties": { "description": "Request parameters to transfer billing subscription.", "x-ms-client-flatten": true, "$ref": "#/definitions/TransferBillingSubscriptionResultProperties" } } }, "TransferBillingSubscriptionResultProperties": { "type": "object", "description": "Transfer billing subscription result properties.", "properties": { "billingSubscriptionName": { "type": "string", "description": "The destination billing subscription id." } } }, "TransferBillingSubscriptionRequest": { "type": "object", "description": "Request parameters to transfer billing subscription.", "properties": { "properties": { "description": "Request parameters to transfer billing subscription.", "x-ms-client-flatten": true, "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties" } } }, "TransferBillingSubscriptionRequestProperties": { "type": "object", "description": "Request parameters to transfer billing subscription.", "properties": { "destinationInvoiceSectionId": { "type": "string", "description": "The destination invoice section id." }, "destinationBillingProfileId": { "type": "string", "description": "The destination billing profile id." } } }, "ValidateSubscriptionTransferEligibilityResult": { "type": "object", "description": "Result of the transfer eligibility validation.", "properties": { "isTransferEligible": { "description": "Specifies whether the transfer is eligible or not.", "type": "boolean", "readOnly": true }, "errorDetails": { "description": "Validation error details.", "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityError" } } }, "ValidateSubscriptionTransferEligibilityError": { "type": "object", "description": "Error details of the transfer eligibility validation", "properties": { "code": { "description": "Error code for the product transfer validation.", "$ref": "#/definitions/SubscriptionTransferValidationErrorCode" }, "message": { "description": "The error message.", "type": "string" }, "details": { "description": "Detailed error message explaining the error.", "type": "string" } } }, "SubscriptionTransferValidationErrorCode": { "type": "string", "description": "Error code of the transfer validation response.", "enum": [ "InvalidSource", "SubscriptionNotActive", "InsufficientPermissionOnSource", "InsufficientPermissionOnDestination", "DestinationBillingProfilePastDue", "SubscriptionTypeNotSupported", "CrossBillingAccountNotAllowed", "NotAvailableForDestinationMarket" ], "x-ms-enum": { "name": "subscriptionTransferValidationErrorCode", "modelAsString": true } }, "UpdateAutoRenewOperationSummary": { "type": "object", "description": "Summary of cancel product operation", "properties": { "properties": { "description": "Summary of update auto renew operation summary properties", "x-ms-client-flatten": true, "$ref": "#/definitions/UpdateAutoRenewOperationSummaryProperties" } } }, "UpdateAutoRenewOperationSummaryProperties": { "type": "object", "description": "update auto renew operation summary properties", "properties": { "endDate": { "type": "string", "format": "date-time", "description": "The end date of this asset" } } }, "BillingAccountListResult": { "description": "Result of listing billing accounts.", "properties": { "value": { "description": "The list of billing accounts.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingAccount" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "BillingAccount": { "description": "A billing account resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "A billing account.", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingAccountProperties" } } }, "BillingAccountProperties": { "description": "The properties of the billing account.", "properties": { "displayName": { "description": "The billing account name.", "type": "string", "readOnly": true }, "accountType": { "description": "The billing account Type.", "type": "string", "enum": [ "Organization", "Enrollment" ], "readOnly": true }, "address": { "description": "The address associated with billing account.", "$ref": "#/definitions/Address" }, "company": { "description": "Company Name.", "type": "string", "readOnly": true }, "country": { "description": "Country Name.", "type": "string", "readOnly": true }, "invoiceSections": { "description": "The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand.", "type": "array", "items": { "$ref": "#/definitions/InvoiceSection" } }, "billingProfiles": { "description": "The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand.", "type": "array", "items": { "$ref": "#/definitions/BillingProfile" } }, "enrollmentDetails": { "description": "The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand.", "$ref": "#/definitions/Enrollment", "readOnly": true }, "departments": { "description": "The departments associated to the enrollment.", "type": "array", "items": { "$ref": "#/definitions/Department" } }, "enrollmentAccounts": { "description": "The accounts associated to the enrollment.", "type": "array", "items": { "$ref": "#/definitions/EnrollmentAccount" } }, "hasReadAccess": { "description": "Specifies whether the user has read access on billing account.", "type": "boolean", "readOnly": true } } }, "BillingAccountUpdateProperties": { "description": "The properties of the billing account that can be updated.", "properties": { "properties": { "description": "A billing property.", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingAccountProperties" } } }, "BillingProperty": { "description": "A billing property resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "A billing property.", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingPropertySummary" } } }, "BillingPropertySummary": { "description": "The billing property.", "properties": { "billingTenantId": { "description": "Billing tenant Id.", "type": "string", "readOnly": true }, "billingAccountId": { "description": "Billing account Id.", "type": "string", "readOnly": true }, "billingAccountName": { "description": "Billing account name.", "type": "string", "readOnly": true }, "billingProfileId": { "description": "Billing profile Id.", "type": "string", "readOnly": true }, "billingProfileName": { "description": "Billing profile name.", "type": "string", "readOnly": true }, "costCenter": { "description": "Cost center name.", "type": "string", "readOnly": true }, "invoiceSectionId": { "description": "Invoice Section Id.", "type": "string", "readOnly": true }, "invoiceSectionName": { "description": "Invoice Section name.", "type": "string", "readOnly": true }, "productId": { "description": "Product Id.", "type": "string", "readOnly": true }, "productName": { "description": "Product name.", "type": "string", "readOnly": true }, "skuId": { "description": "SKU Id.", "type": "string", "readOnly": true }, "skuDescription": { "description": "SKU description.", "type": "string", "readOnly": true } } }, "Enrollment": { "description": "Current entity level details", "properties": { "startDate": { "description": "Enrollment Start Date", "type": "string", "format": "date-time" }, "endDate": { "description": "Enrollment End Date", "type": "string", "format": "date-time" }, "currency": { "description": "The currency associated with enrollment", "type": "string", "readOnly": true }, "channel": { "description": "The channel for Enrollment", "type": "string", "readOnly": true }, "policies": { "description": "The attributes associated with legacy enrollment.", "$ref": "#/definitions/EnrollmentPolicies", "readOnly": true }, "language": { "description": "The language for Enrollment", "type": "string", "readOnly": true }, "countryCode": { "description": "The countryCode for Enrollment", "type": "string", "readOnly": true }, "status": { "description": "Enrollment status", "type": "string", "readOnly": true }, "billingCycle": { "description": "Enrollment billing cycle", "type": "string", "readOnly": true } } }, "EnrollmentPolicies": { "description": "The attributes associated with legacy enrollment", "properties": { "accountOwnerViewCharges": { "description": "The accountOwnerViewCharges flag for Enrollment", "type": "boolean", "readOnly": true }, "departmentAdminViewCharges": { "description": "The departmentAdminViewCharges flag for Enrollment", "type": "boolean", "readOnly": true }, "marketplacesEnabled": { "description": "The marketplaces flag for Enrollment", "type": "boolean", "readOnly": true }, "reservedInstancesEnabled": { "description": "The reserved instances flag for Enrollment", "type": "boolean", "readOnly": true } } }, "DepartmentListResult": { "description": "Result of listing departments.", "properties": { "value": { "description": "The list of departments.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Department" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "Department": { "description": "A department resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "A department.", "x-ms-client-flatten": true, "$ref": "#/definitions/DepartmentProperties" } } }, "DepartmentProperties": { "description": "The properties of the department.", "properties": { "departmentName": { "description": "The name for department.", "type": "string" }, "costCenter": { "description": "The cost center name.", "type": "string" }, "status": { "description": "The status for department.", "type": "string" }, "enrollmentAccounts": { "description": "Associated enrollment accounts. By default this is not populated, unless it's specified in $expand.", "type": "array", "items": { "$ref": "#/definitions/EnrollmentAccount" } } } }, "EnrollmentAccountListResult": { "description": "Result of listing enrollment accounts.", "properties": { "value": { "description": "The list of enrollment accounts.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/EnrollmentAccount" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "EnrollmentAccount": { "description": "An account resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "An account.", "x-ms-client-flatten": true, "$ref": "#/definitions/EnrollmentAccountProperties" } } }, "EnrollmentAccountProperties": { "description": "The properties of the account.", "properties": { "accountName": { "description": "The account name.", "type": "string" }, "costCenter": { "description": "The cost center name.", "type": "string" }, "accountOwner": { "description": "The account owner", "type": "string" }, "status": { "description": "The status for account.", "type": "string" }, "startDate": { "description": "Account Start Date", "type": "string", "format": "date-time" }, "endDate": { "description": "Account End Date", "type": "string", "format": "date-time" }, "department": { "description": "Associated department. By default this is not populated, unless it's specified in $expand.", "$ref": "#/definitions/Department" } } }, "BillingProfileListResult": { "description": "Result of listing billing profiles.", "properties": { "value": { "description": "The list of billing profiles.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingProfile" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "BillingProfile": { "description": "A billing profile resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "A billing profile.", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingProfileProperties" } } }, "BillingProfileCreationParameters": { "description": "The parameters for creating a new billing profile.", "properties": { "displayName": { "description": "The billing profile name.", "type": "string" }, "poNumber": { "description": "Purchase order number.", "type": "string" }, "address": { "description": "Billing address.", "$ref": "#/definitions/Address" }, "invoiceEmailOptIn": { "description": "If the billing profile is opted in to receive invoices via email.", "type": "boolean" }, "enableAzureSKUs": { "description": "Azure skus to enable for this billing profile..", "type": "array", "items": { "$ref": "#/definitions/EnabledAzureSKUs" } } } }, "BillingProfileProperties": { "description": "The properties of the billing profile.", "properties": { "displayName": { "description": "The billing profile name.", "type": "string" }, "poNumber": { "description": "Purchase order number.", "type": "string" }, "address": { "description": "Billing address.", "$ref": "#/definitions/Address" }, "invoiceEmailOptIn": { "description": "If the billing profile is opted in to receive invoices via email.", "type": "boolean", "readOnly": true }, "isClassic": { "description": "Is OMS bootstrapped billing profile.", "type": "boolean", "readOnly": true }, "invoiceDay": { "description": "Invoice day.", "type": "integer", "format": "int32", "readOnly": true }, "currency": { "description": "The currency associated with the billing profile.", "type": "string", "readOnly": true }, "enabledAzureSKUs": { "description": "Information about the product.", "type": "array", "items": { "$ref": "#/definitions/EnabledAzureSKUs" } }, "invoiceSections": { "description": "The invoice sections associated to the billing profile.", "type": "array", "items": { "$ref": "#/definitions/InvoiceSection" } } } }, "Address": { "description": "Address details.", "properties": { "firstName": { "description": "First Name.", "type": "string" }, "lastName": { "description": "Last Name.", "type": "string" }, "companyName": { "description": "Company Name.", "type": "string" }, "addressLine1": { "description": "Address Line1.", "type": "string" }, "addressLine2": { "description": "Address Line2.", "type": "string" }, "addressLine3": { "description": "Address Line3.", "type": "string" }, "city": { "description": "Address City.", "type": "string" }, "region": { "description": "Address Region.", "type": "string" }, "country": { "description": "Country code uses ISO2, 2-digit format.", "type": "string" }, "postalCode": { "description": "Address Postal Code.", "type": "string" } } }, "CustomerListResult": { "description": "Result of listing customers.", "properties": { "value": { "description": "The list of customers.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Customer" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "Customer": { "description": "A partner's customer.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "The customer.", "x-ms-client-flatten": true, "$ref": "#/definitions/CustomerProperties" } } }, "CustomerProperties": { "description": "The properties of a customer.", "properties": { "displayName": { "description": "The name of the customer.", "type": "string" }, "enabledAzureSKUs": { "description": "Information about the product.", "type": "array", "items": { "$ref": "#/definitions/EnabledAzureSKUs" } }, "resellers": { "description": "The resellers which are allowed to provide service to this customer.", "type": "array", "items": { "$ref": "#/definitions/Reseller" } } } }, "InvoiceSectionCreationRequest": { "description": "The properties of an InvoiceSection.", "properties": { "displayName": { "description": "The name of the InvoiceSection.", "type": "string" }, "billingProfileId": { "description": "The billing profile id.", "type": "string" } } }, "InvoiceSectionListResult": { "description": "Result of listing invoice sections.", "properties": { "value": { "description": "The list of invoice sections.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/InvoiceSection" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "InvoiceSection": { "description": "An InvoiceSection resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "The InvoiceSection.", "x-ms-client-flatten": true, "$ref": "#/definitions/InvoiceSectionProperties" } } }, "InvoiceSectionProperties": { "description": "The properties of an InvoiceSection.", "properties": { "displayName": { "description": "The name of the InvoiceSection.", "type": "string" }, "billingProfiles": { "description": "The billing profiles associated to the billing account.", "type": "array", "items": { "$ref": "#/definitions/BillingProfile" } } } }, "EnabledAzureSKUs": { "description": "Details about the enabled azure sku.", "properties": { "skuId": { "description": "The sku id.", "type": "string" }, "skuDescription": { "description": "The sku description.", "type": "string", "readOnly": true } } }, "Reseller": { "description": "Details about a reseller.", "properties": { "resellerId": { "description": "The reseller id.", "type": "string", "readOnly": true }, "description": { "description": "A description of the reseller.", "type": "string", "readOnly": true } } }, "OperationStatus": { "description": "status of the Billing POST/PUT operation.", "properties": { "id": { "type": "string", "description": "The operation Id.", "readOnly": true }, "status": { "description": "Status of the pending operation", "type": "string" }, "statusDetail": { "description": "Status Detail of the pending operation", "type": "string" } } }, "DownloadUrl": { "description": "A secure URL that can be used to download a an entity until the URL expires.", "properties": { "expiryTime": { "description": "The time in UTC at which this download URL will expire.", "type": "string", "format": "date-time", "readOnly": true }, "url": { "description": "The URL to the PDF file.", "type": "string", "readOnly": true } } }, "ErrorDetails": { "description": "The details of the error.", "properties": { "code": { "description": "Error code.", "type": "string", "readOnly": true }, "message": { "description": "Error message indicating why the operation failed.", "type": "string", "readOnly": true }, "target": { "description": "The target of the particular error.", "type": "string", "readOnly": true } } }, "ErrorResponse": { "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "error": { "description": "The details of the error.", "$ref": "#/definitions/ErrorDetails" } } }, "Resource": { "description": "The Resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id." }, "name": { "readOnly": true, "type": "string", "description": "Resource name." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "x-ms-azure-resource": true }, "InvoiceListResult": { "description": "Result of listing invoices.", "properties": { "value": { "description": "The list of invoices.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/InvoiceSummary" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "InvoiceSummary": { "description": "An invoice resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "An invoice.", "x-ms-client-flatten": true, "$ref": "#/definitions/InvoiceSummaryProperties" } } }, "InvoiceSummaryProperties": { "description": "The properties of the invoice.", "properties": { "dueDate": { "description": "The due date for invoice.", "type": "string", "format": "date-time", "readOnly": true }, "invoiceDate": { "description": "The date when invoice was created.", "type": "string", "format": "date-time", "readOnly": true }, "status": { "description": "Invoice status.", "type": "string", "enum": [ "PastDue", "Due", "Paid", "Void" ], "readOnly": true }, "amountDue": { "description": "Amount due.", "readOnly": true, "$ref": "#/definitions/Amount" }, "billedAmount": { "description": "Amount billed.", "readOnly": true, "$ref": "#/definitions/Amount" }, "invoicePeriodStartDate": { "description": "The start date of the billing period.", "type": "string", "format": "date-time", "readOnly": true }, "invoicePeriodEndDate": { "description": "The end date of the billing period.", "type": "string", "format": "date-time", "readOnly": true }, "billingProfileId": { "description": "The billing profile id this invoice belongs to.", "type": "string", "readOnly": true }, "billingProfileName": { "description": "The profile name this invoice belongs to.", "type": "string", "readOnly": true }, "purchaseOrderNumber": { "description": "The purchase identifier for the invoice.", "type": "string", "readOnly": true }, "documentUrls": { "description": "List of document urls available to download including invoice and tax documents.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/DownloadProperties" } }, "payments": { "description": "List of payments.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/PaymentProperties" } } } }, "PaymentProperties": { "description": "The properties of the payment.", "properties": { "paymentType": { "description": "The type of payment.", "type": "string", "readOnly": true }, "amount": { "description": "The paid amount.", "readOnly": true, "$ref": "#/definitions/Amount" }, "date": { "description": "The date of the payment.", "type": "string", "format": "date-time", "readOnly": true } } }, "DownloadProperties": { "description": "The properties of the invoice download.", "properties": { "kind": { "description": "Document type.", "type": "string", "enum": [ "Invoice", "VoidNote", "Receipt", "CreditNote" ], "readOnly": true }, "url": { "description": "Document URL.", "type": "string", "readOnly": true } } }, "ProductsListResult": { "description": "Result of listing products summary. It contains a list of available products summaries in reverse chronological order by purchase date.", "properties": { "value": { "description": "The list of products summary.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/ProductSummary" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "ProductSummary": { "description": "A product summary resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProductSummaryProperties", "title": "Product summary properties" } } }, "ProductSummaryProperties": { "description": "The properties of the product summary.", "properties": { "displayName": { "description": "The display name of the product.", "type": "string", "readOnly": true }, "purchaseDate": { "description": "The date of purchase.", "type": "string", "format": "date-time", "readOnly": true }, "productTypeId": { "description": "The product type id.", "type": "string", "readOnly": true }, "productType": { "description": "The type of product.", "type": "string", "readOnly": true }, "status": { "description": "Product status.", "type": "string", "enum": [ "Active", "Inactive", "PastDue", "Expiring", "Expired", "Disabled", "Cancelled", "AutoRenew" ], "x-ms-enum": { "name": "ProductStatusType", "modelAsString": true } }, "endDate": { "description": "end date.", "type": "string", "format": "date-time", "readOnly": true }, "billingFrequency": { "description": "Billing frequency.", "type": "string", "enum": [ "OneTime", "Monthly", "UsageBased" ], "x-ms-enum": { "name": "BillingFrequency", "modelAsString": true } }, "lastCharge": { "description": "Last month charges.", "readOnly": true, "$ref": "#/definitions/Amount" }, "lastChargeDate": { "description": "The date of the last charge.", "type": "string", "format": "date-time", "readOnly": true }, "quantity": { "description": "The purchased product quantity.", "type": "number", "readOnly": true }, "skuId": { "description": "Sku Id.", "type": "string", "readOnly": true }, "skuDescription": { "description": "Sku description.", "type": "string", "readOnly": true }, "availabilityId": { "description": "Availability Id.", "type": "string", "readOnly": true }, "parentProductId": { "description": "Parent Product Id.", "type": "string", "readOnly": true }, "invoiceSectionId": { "description": "Invoice section id to which this product belongs.", "type": "string", "readOnly": true }, "invoiceSectionName": { "description": "Invoice section name to which this product belongs.", "type": "string", "readOnly": true }, "billingProfileId": { "description": "Billing Profile id to which this product belongs.", "type": "string", "readOnly": true }, "billingProfileName": { "description": "Billing Profile name to which this product belongs.", "type": "string", "readOnly": true } } }, "ValidateProductTransferEligibilityResult": { "type": "object", "description": "Result of the product transfer eligibility validation.", "properties": { "isTransferEligible": { "description": "Specifies whether the transfer is eligible or not.", "type": "boolean", "readOnly": true }, "errorDetails": { "description": "Validation error details.", "$ref": "#/definitions/ValidateProductTransferEligibilityError" } } }, "ValidateProductTransferEligibilityError": { "type": "object", "description": "Error details of the product transfer eligibility validation.", "properties": { "code": { "description": "Error code for the product transfer validation.", "$ref": "#/definitions/ProductTransferValidationErrorCode" }, "message": { "description": "The error message.", "type": "string" }, "details": { "description": "Detailed error message explaining the error.", "type": "string" } } }, "ProductTransferValidationErrorCode": { "type": "string", "description": "Error code of the transfer validation response.", "enum": [ "InvalidSource", "ProductNotActive", "InsufficientPermissionOnSource", "InsufficientPermissionOnDestination", "DestinationBillingProfilePastDue", "ProductTypeNotSupported", "CrossBillingAccountNotAllowed", "NotAvailableForDestinationMarket", "OneTimePurchaseProductTransferNotAllowed" ], "x-ms-enum": { "name": "productTransferValidationErrorCode", "modelAsString": true } }, "BillingSubscriptionsListResult": { "description": "Result of listing billing subscriptions summary.", "properties": { "value": { "description": "The list of billing subscriptions summary.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingSubscriptionSummary" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "BillingSubscriptionSummary": { "description": "A billing Subscription summary resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BillingSubscriptionProperties", "title": "Billing subscription properties" } } }, "BillingSubscriptionProperties": { "description": "The usage context properties.", "properties": { "displayName": { "description": "display name.", "type": "string", "readOnly": true }, "subscriptionId": { "description": "Subscription Id.", "type": "string", "format": "uuid", "readOnly": true }, "subscriptionBillingStatus": { "description": "Subscription billing status.", "type": "string", "enum": [ "Active", "Inactive", "Abandoned", "Deleted", "Warning" ], "x-ms-enum": { "name": "BillingSubscriptionStatusType", "modelAsString": true } }, "lastMonthCharges": { "description": "Last month charges.", "readOnly": true, "$ref": "#/definitions/Amount" }, "monthToDateCharges": { "description": "Month to date charges.", "readOnly": true, "$ref": "#/definitions/Amount" }, "billingProfileId": { "description": "Billing Profile id to which this product belongs.", "type": "string", "readOnly": true }, "billingProfileName": { "description": "Billing Profile name to which this product belongs.", "type": "string", "readOnly": true }, "customerId": { "description": "Customer id to which this product belongs.", "type": "string", "readOnly": true }, "customerDisplayName": { "description": "Display name of customer to which this product belongs.", "type": "string", "readOnly": true }, "invoiceSectionId": { "description": "Invoice section id to which this product belongs.", "type": "string", "readOnly": true }, "invoiceSectionName": { "description": "Invoice section name to which this product belongs.", "type": "string", "readOnly": true }, "skuId": { "description": "The sku id.", "type": "string" }, "skuDescription": { "description": "The sku description.", "type": "string", "readOnly": true }, "reseller": { "description": "Reseller for this subscription.", "readOnly": true, "$ref": "#/definitions/Reseller" } } }, "EnrollmentAccountContext": { "description": "The rating context.", "properties": { "costCenter": { "description": "The cost center name.", "type": "string" }, "startDate": { "description": "Account Start Date", "type": "string", "format": "date-time" }, "endDate": { "description": "Account End Date", "type": "string", "format": "date-time" }, "enrollmentAccountName": { "description": "The enrollment account id.", "type": "string" } } }, "TransactionsListResult": { "description": "Result of listing reservation transactions summary.", "properties": { "value": { "description": "The list of reservation transactions summary.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/TransactionsSummary" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "TransactionsSummary": { "description": "A reservation transaction summary resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TransactionsSummaryProperties", "title": "Reservation transaction summary properties" } } }, "TransactionsSummaryProperties": { "description": "The properties of the reservation transaction summary.", "properties": { "kind": { "type": "string", "description": "The kind of transaction. Choices are all and reservation.", "enum": [ "all", "reservation" ], "x-ms-enum": { "name": "TransactionTypeKind", "modelAsString": true } }, "date": { "description": "The date of reservation transaction.", "type": "string", "format": "date-time", "readOnly": true }, "invoice": { "description": "Invoice number or 'pending' if not invoiced.", "type": "string", "readOnly": true }, "orderId": { "description": "The reservation order id.", "type": "string", "readOnly": true }, "orderName": { "description": "The reservation order name.", "type": "string", "readOnly": true }, "productFamily": { "description": "The product family.", "type": "string", "readOnly": true }, "productTypeId": { "description": "The product type id.", "type": "string", "readOnly": true }, "productType": { "description": "The type of product.", "type": "string", "readOnly": true }, "productDescription": { "description": "Product description.", "type": "string", "readOnly": true }, "transactionType": { "description": "Transaction types.", "type": "string", "enum": [ "Purchase", "Usage Charge" ], "x-ms-enum": { "name": "ReservationType", "modelAsString": true } }, "transactionAmount": { "description": "Last charge associated with the purchase.", "readOnly": true, "$ref": "#/definitions/Amount" }, "quantity": { "description": "Purchase quantity.", "type": "integer", "format": "int32", "readOnly": true }, "customerId": { "description": "Customer id to which this product belongs.", "type": "string", "readOnly": true }, "customerDisplayName": { "description": "Display name of customer to which this product belongs.", "type": "string", "readOnly": true }, "invoiceSectionId": { "description": "Invoice section id to which this product belongs.", "type": "string", "readOnly": true }, "invoiceSectionName": { "description": "Invoice section name to which this product belongs.", "type": "string", "readOnly": true }, "billingProfileId": { "description": "Billing Profile id to which this product belongs.", "type": "string", "readOnly": true }, "billingProfileName": { "description": "Billing Profile name to which this product belongs.", "type": "string", "readOnly": true }, "subscriptionId": { "description": "The subscription id.", "type": "string", "readOnly": true }, "subscriptionName": { "description": "The subscription name.", "type": "string", "readOnly": true } } }, "Policy": { "description": "The Policy.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyProperties", "title": "Policy properties" } } }, "PolicyProperties": { "description": "The properties of policy.", "properties": { "marketplacePurchasesAllowed": { "description": "The marketplacePurchasesAllowed flag.", "type": "boolean" }, "reservationPurchasesAllowed": { "description": "The reservationPurchasesAllowed flag.", "type": "boolean" }, "subscriptionOwnerCanViewCharges": { "description": "The subscriptionOwnerCanViewCharges flag.", "type": "boolean" } } }, "AvailableBalance": { "description": "Latest available balance on Monetary Credit PI.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AvailableBalanceProperties", "title": "Available balance properties" } } }, "AvailableBalanceProperties": { "description": "The properties of available balance.", "properties": { "amount": { "description": "Balance Amount.", "readOnly": true, "$ref": "#/definitions/Amount" } } }, "Amount": { "description": "The Amount.", "properties": { "currency": { "description": "The currency for the amount value.", "type": "string", "readOnly": true }, "value": { "description": "Amount value.", "type": "number" } } }, "PaymentMethodsListResult": { "description": "Result of listing payment methods.", "properties": { "value": { "description": "The list of payment methods.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/PaymentMethod" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "PaymentMethod": { "description": "A payment method resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PaymentMethodProperties", "title": "Payment method properties" } } }, "PaymentMethodProperties": { "description": "The properties of the payment method.", "properties": { "paymentMethodType": { "description": "Payment method type.", "type": "string", "enum": [ "Credits", "ChequeWire" ], "x-ms-enum": { "name": "PaymentMethodType", "modelAsString": true } }, "details": { "description": "Details about the payment method.", "type": "string", "readOnly": true }, "expiration": { "description": "Expiration date.", "type": "string", "format": "date-time", "readOnly": true }, "currency": { "description": "The currency associated with the payment method.", "type": "string", "readOnly": true } } }, "UpdateAutoRenewRequest": { "type": "object", "description": "Request parameters to update auto renew for support product.", "properties": { "autoRenew": { "description": "Request parameters to update auto renew policy a product.", "type": "string", "enum": [ "true", "false" ], "x-ms-enum": { "name": "UpdateAutoRenew", "modelAsString": true } } } }, "Operation": { "description": "A Billing REST API operation.", "type": "object", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}.", "type": "string", "readOnly": true }, "display": { "description": "The object that represents the operation.", "properties": { "provider": { "description": "Service provider: Microsoft.Billing.", "type": "string", "readOnly": true }, "resource": { "description": "Resource on which the operation is performed: Invoice, etc.", "type": "string", "readOnly": true }, "operation": { "description": "Operation type: Read, write, delete, etc.", "type": "string", "readOnly": true } } } } }, "OperationListResult": { "description": "Result listing billing operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "description": "List of billing operations supported by the Microsoft.Billing resource provider.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Operation" } }, "nextLink": { "description": "URL to get the next set of operation list results if there are any.", "type": "string", "readOnly": true } } }, "BillingRoleAssignmentPayload": { "description": "The payload use to update role assignment on a scope", "properties": { "principalId": { "description": "The user's principal id that the role gets assigned to", "type": "string" }, "billingRoleDefinitionId": { "description": "The role definition id", "type": "string" } } }, "BillingRoleAssignmentListResult": { "description": "Result of get list of role assignments", "properties": { "value": { "description": "The list role assignments", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingRoleAssignment" } } } }, "BillingRoleAssignment": { "description": "a role assignment", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "The role assignment the caller has", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingRoleAssignmentProperties" } } }, "BillingRoleAssignmentProperties": { "description": "The properties of the a role assignment.", "properties": { "createdOn": { "description": "the date the role assignment is created", "type": "string", "readOnly": true }, "createdByPrincipalTenantId": { "description": "the creator's tenant Id", "type": "string", "readOnly": true }, "createdByPrincipalId": { "description": "the creator's principal Id", "type": "string", "readOnly": true }, "name": { "description": "the name of the role assignment", "type": "string", "readOnly": true }, "principalId": { "description": "The user's principal id that the role gets assigned to", "type": "string", "readOnly": true }, "roleDefinitionName": { "description": "The role definition id", "type": "string", "readOnly": true }, "scope": { "description": "The scope the role get assigned to", "type": "string", "readOnly": true } } }, "BillingRoleDefinitionListResult": { "description": "list the role definitions.", "properties": { "value": { "description": "The list of role definitions.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingRoleDefinition" } } } }, "BillingRoleDefinition": { "description": "Result of get role definition for a role.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "The role definition for a role.", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingRoleDefinitionProperties" } } }, "BillingRoleDefinitionProperties": { "description": "The properties of the a role definition.", "properties": { "description": { "description": "The role description", "type": "string", "readOnly": true }, "permissions": { "description": "The billingPermissions the role has", "x-ms-client-flatten": true, "$ref": "#/definitions/BillingPermissionsListResult" }, "roleName": { "description": "The name of the role", "type": "string", "readOnly": true } } }, "BillingPermissionsListResult": { "description": "Result of list billingPermissions a caller has on a billing account.", "properties": { "value": { "description": "The list OF billingPermissions a caller has on a billing account.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/BillingPermissionsProperties" } } } }, "BillingPermissionsProperties": { "description": "The set of allowed action and not allowed actions a caller has on a billing account", "type": "object", "properties": { "actions": { "description": "The set of actions that the caller is allowed to do", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Action" } }, "notActions": { "description": "The set of actions the caller is not allowed to do", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/NotAction" } } } }, "AgreementListResult": { "description": "Result of listing agreements.", "properties": { "value": { "description": "The list of agreements.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Agreement" } }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", "readOnly": true } } }, "Agreement": { "description": "An agreement resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "An agreement.", "x-ms-client-flatten": true, "$ref": "#/definitions/AgreementProperties" } } }, "AgreementProperties": { "description": "The properties of the agreement.", "properties": { "agreementLink": { "description": "The link to the agreement.", "type": "string", "readOnly": true }, "effectiveDate": { "description": "Effective date.", "type": "string", "format": "date-time", "readOnly": true }, "expirationDate": { "description": "Expiration date.", "type": "string", "format": "date-time", "readOnly": true }, "participants": { "description": "Participants or signer of the agreement.", "type": "array", "items": { "$ref": "#/definitions/Participants" } }, "status": { "description": "The agreement status", "type": "string", "readOnly": true } } }, "Participants": { "description": "Details about the participant or signer.", "properties": { "status": { "description": "The signing status", "type": "string", "readOnly": true }, "statusDate": { "description": "The date when status got changed.", "type": "string", "format": "date-time", "readOnly": true }, "email": { "description": "The email address of the participant or signer.", "type": "string", "readOnly": true } } }, "LineOfCredit": { "description": "Line of credit resource.", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { "properties": { "description": "A line of credit.", "x-ms-client-flatten": true, "$ref": "#/definitions/LineOfCreditProperties" } } }, "LineOfCreditProperties": { "description": "The properties of the line of credit.", "properties": { "creditLimit": { "description": "The current credit limit.", "$ref": "#/definitions/Amount", "readOnly": false }, "reason": { "description": "The reason for the line of credit status when not approved.", "type": "string", "readOnly": true }, "remainingBalance": { "description": "Remaining balance.", "$ref": "#/definitions/Amount", "readOnly": true }, "status": { "description": "The line of credit status.", "type": "string", "enum": [ "Approved", "Rejected" ], "x-ms-enum": { "name": "status", "modelAsString": true } } } }, "Action": { "description": "the action the caller allowed to do", "type": "string", "readOnly": true }, "NotAction": { "description": "the action the caller doesn't allowed to do", "type": "string", "readOnly": true } }, "parameters": { "apiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Version of the API to be used with the client request. The current version is 2018-11-01-preview." }, "subscriptionIdParameter": { "name": "subscriptionId", "in": "path", "description": "Azure Subscription Id.", "required": true, "type": "string" }, "billingAccountNameParameter": { "name": "billingAccountName", "in": "path", "description": "Billing Account Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "customerNameParameter": { "name": "customerName", "in": "path", "description": "Customer Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "invoiceSectionNameParameter": { "name": "invoiceSectionName", "in": "path", "description": "InvoiceSection Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "enrollmentAccountNameParameter": { "name": "enrollmentAccountName", "in": "path", "description": "Enrollment Account Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "departmentNameParameter": { "name": "departmentName", "in": "path", "description": "Department Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "billingProfileNameParameter": { "name": "billingProfileName", "in": "path", "description": "Billing Profile Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "updateAutoRenewRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, "description": "Update auto renew request parameters.", "schema": { "$ref": "#/definitions/UpdateAutoRenewRequest" } }, "operationIdParameter": { "name": "operationId", "in": "path", "description": "Operation Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "billingRoleDefinitionNameParameter": { "name": "billingRoleDefinitionName", "in": "path", "description": "role definition id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "billingRoleAssignmentNameParameter": { "name": "billingRoleAssignmentName", "in": "path", "description": "role assignment id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "invoiceNameParameter": { "name": "invoiceName", "in": "path", "description": "Invoice Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "productNameParameter": { "name": "productName", "in": "path", "description": "Invoice Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "billingSubscriptionNameParameter": { "name": "billingSubscriptionName", "in": "path", "description": "Billing Subscription Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "transferNameParameter": { "name": "transferName", "x-ms-parameter-location": "method", "in": "path", "required": true, "type": "string", "description": "Transfer Name." }, "initiateTransferRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, "description": "Initiate transfer parameters.", "schema": { "$ref": "#/definitions/InitiateTransferRequest" } }, "acceptTransferRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, "description": "Accept transfer parameters.", "schema": { "$ref": "#/definitions/AcceptTransferRequest" } }, "agreementNameParameter": { "name": "agreementName", "in": "path", "description": "Agreement Id.", "required": true, "type": "string", "x-ms-parameter-location": "method" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } } }