swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Balances API
schemes:
- https
tags:
- name: Balances
paths:
  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances:
    get:
      tags:
      - Balances
      operationId: microsoftAzureBalancesGetbybillingaccount
      description: Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        Balances:
          $ref: ./examples/BalancesByBillingAccount.json
      parameters:
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/billingAccountIdParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Balance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountid Providers Microsoft Consumption Balances
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances
  : get:
      tags:
      - Balances
      operationId: microsoftAzureBalancesGetforbillingperiodbybillingaccount
      description: Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        Balances:
          $ref: ./examples/BalancesByBillingAccountForBillingPeriod.json
      parameters:
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/billingAccountIdParameter'
      - $ref: '#/parameters/billingPeriodNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Balance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountid Providers Microsoft Billing Billingperiods Billingperiodname Providers Microsoft Consumption Balances
definitions:
  BalanceProperties:
    description: The properties of the balance.
    type: object
    properties:
      currency:
        description: The ISO currency in which the meter is charged, for example, USD.
        type: string
        readOnly: true
      beginningBalance:
        description: The beginning balance for the billing period.
        type: number
        format: decimal
        readOnly: true
      endingBalance:
        description: The ending balance for the billing period (for open periods this will be updated daily).
        type: number
        format: decimal
        readOnly: true
      newPurchases:
        description: Total new purchase amount.
        type: number
        format: decimal
        readOnly: true
      adjustments:
        description: Total adjustment amount.
        type: number
        format: decimal
        readOnly: true
      utilized:
        description: Total Commitment usage.
        type: number
        format: decimal
        readOnly: true
      serviceOverage:
        description: Overage for Azure services.
        type: number
        format: decimal
        readOnly: true
      chargesBilledSeparately:
        description: Charges Billed separately.
        type: number
        format: decimal
        readOnly: true
      totalOverage:
        description: serviceOverage + chargesBilledSeparately.
        type: number
        format: decimal
        readOnly: true
      totalUsage:
        description: Azure service commitment + total Overage.
        type: number
        format: decimal
        readOnly: true
      azureMarketplaceServiceCharges:
        description: Total charges for Azure Marketplace.
        type: number
        format: decimal
        readOnly: true
      billingFrequency:
        description: The billing frequency.
        type: string
        enum:
        - Month
        - Quarter
        - Year
        x-ms-enum:
          name: BillingFrequency
          modelAsString: true
      priceHidden:
        description: Price is hidden or not.
        type: boolean
        readOnly: true
      newPurchasesDetails:
        description: List of new purchases.
        type: array
        items:
          type: object
          properties:
            name:
              description: the name of new purchase.
              type: string
              readOnly: true
            value:
              description: the value of new purchase.
              type: number
              format: decimal
              readOnly: true
        readOnly: true
      adjustmentDetails:
        description: List of Adjustments (Promo credit, SIE credit etc.).
        type: array
        items:
          type: object
          properties:
            name:
              description: the name of new adjustment.
              type: string
              readOnly: true
            value:
              description: the value of new adjustment.
              type: number
              format: decimal
              readOnly: true
        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.
      tags:
        readOnly: true
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    x-ms-azure-resource: 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
  Balance:
    description: A balance resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/BalanceProperties'
        title: Balance properties
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 2019-04-01-preview.
  billingAccountIdParameter:
    name: billingAccountId
    in: path
    description: BillingAccount ID
    required: true
    type: string
    x-ms-parameter-location: method
  billingPeriodNameParameter:
    name: billingPeriodName
    in: path
    description: Billing Period Name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'