swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RateCard API
schemes:
- https
tags:
- name: RateCard
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Commerce/RateCard:
    get:
      tags:
      - RateCard
      operationId: microsoftAzureRatecardGet
      description: 'Enables you to query for the resource/meter metadata and related prices used in a given subscription by Offer ID, Currency, Locale and Region. The metadata associated with the billing meters, including but not limited to service names, types, resources, units of measure, and regions, is subject to change at any time and without notice. If you intend to use this billing data in an automated fashion, please use the billing meter GUID to uniquely identify each billable item. If the billing meter GUID is scheduled to change due to a new billing model, you will be notified in advance of the change. '
      externalDocs:
        url: https://docs.microsoft.com/rest/api/commerce/ratecard
      x-ms-examples:
        GetRateCard:
          $ref: ./examples/GetRateCard.json
      parameters:
      - name: $filter
        in: query
        required: true
        type: string
        description: The filter to apply on the operation. It ONLY supports the 'eq' and 'and' logical operators at this time. All the 4 query parameters 'OfferDurableId',  'Currency', 'Locale', 'Region' are required to be a part of the $filter.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.
          schema:
            $ref: '#/definitions/ResourceRateCardInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-odata: '#/definitions/RateCardQueryParameters'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Commerce Ratecard
definitions:
  ErrorResponse:
    description: Describes the format of Error response.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  MeterInfo:
    description: Detailed information about the meter.
    properties:
      MeterId:
        description: The unique identifier of the resource.
        type: string
        format: uuid
      MeterName:
        description: The name of the meter, within the given meter category
        type: string
      MeterCategory:
        description: The category of the meter, e.g., 'Cloud services', 'Networking', etc..
        type: string
      MeterSubCategory:
        description: The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc..
        type: string
      Unit:
        description: The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc.
        type: string
      MeterTags:
        type: array
        items:
          type: string
        description: Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party.
      MeterRegion:
        description: The region in which the Azure service is available.
        type: string
      MeterRates:
        description: The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price
        type: object
        additionalProperties:
          type: number
          format: float
      EffectiveDate:
        description: Indicates the date from which the meter rate is effective.
        type: string
        format: date-time
      IncludedQuantity:
        description: The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged.
        type: number
        format: float
  ResourceRateCardInfo:
    description: Price and Metadata information for resources
    properties:
      Currency:
        description: The currency in which the rates are provided.
        type: string
      Locale:
        description: The culture in which the resource information is localized.
        type: string
      IsTaxIncluded:
        description: All rates are pretax, so this will always be returned as 'false'.
        type: boolean
      OfferTerms:
        type: array
        items:
          $ref: '#/definitions/OfferTermInfo'
        x-ms-identifiers:
        - Name
        description: A list of offer terms.
      Meters:
        type: array
        items:
          $ref: '#/definitions/MeterInfo'
        x-ms-identifiers:
        - MeterId
        description: A list of meters.
  OfferTermInfo:
    description: Describes the offer term.
    discriminator: Name
    required:
    - Name
    properties:
      Name:
        description: Name of the offer term
        type: string
        enum:
        - Recurring Charge
        - Monetary Commitment
        - Monetary Credit
        x-ms-enum:
          name: OfferTermInfo
          modelAsString: false
      EffectiveDate:
        description: Indicates the date from which the offer term is effective.
        type: string
        format: date-time
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'