swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Savings Plan Order API
schemes:
- https
tags:
- name: Savings Plan Order
paths:
  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}:
    get:
      description: Get a savings plan order.
      operationId: microsoftAzureSavingsplanorderGet
      tags:
      - Savings Plan Order
      x-ms-examples:
        SavingsPlanOrderGet:
          $ref: ./examples/SavingsPlanOrderGet.json
        SavingsPlanOrderWithExpandedPaymentsGet:
          $ref: ./examples/SavingsPlanOrderExpandedGet.json
      parameters:
      - $ref: '#/parameters/SavingsPlanOrderIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ExpandParameter'
      responses:
        '200':
          description: The request is completed.
          schema:
            $ref: '#/definitions/SavingsPlanOrderModel'
        default:
          description: Unexpected error.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Providers Microsoft Billingbenefits Savingsplanorders Savingsplanorderid
  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/elevate:
    post:
      description: Elevate as owner on savings plan order based on billing permissions.
      operationId: microsoftAzureSavingsplanorderElevate
      tags:
      - Savings Plan Order
      x-ms-examples:
        SavingsPlanOrderElevate:
          $ref: ./examples/SavingsPlanOrderElevate.json
      parameters:
      - $ref: '#/parameters/SavingsPlanOrderIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request is completed.
          schema:
            $ref: '#/definitions/RoleAssignmentEntity'
        default:
          description: Unexpected error.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Providers Microsoft Billingbenefits Savingsplanorders Savingsplanorderid Elevate
  /providers/Microsoft.BillingBenefits/savingsPlanOrders:
    get:
      description: List all Savings plan orders.
      operationId: microsoftAzureSavingsplanorderList
      tags:
      - Savings Plan Order
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SavingsPlanOrderList:
          $ref: ./examples/SavingsPlanOrderList.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request is completed.
          schema:
            $ref: '#/definitions/SavingsPlanOrderModelList'
        default:
          description: Unexpected error.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Providers Microsoft Billingbenefits Savingsplanorders
definitions:
  Price:
    type: object
    properties:
      currencyCode:
        type: string
        description: The ISO 4217 3-letter currency code for the currency used by this purchase record.
      amount:
        type: number
        format: double
  BenefitStartTime:
    type: string
    format: date-time
    description: This is the DateTime when the savings plan benefit started.
  PaymentDetail:
    type: object
    description: Information about payment related to a savings plan order.
    properties:
      dueDate:
        type: string
        format: date
        description: Date when the payment needs to be done.
      paymentDate:
        type: string
        format: date
        description: Date when the transaction is completed. Is null when it is scheduled.
      pricingCurrencyTotal:
        $ref: '#/definitions/Price'
        description: Amount in pricing currency. Tax not included.
      billingCurrencyTotal:
        $ref: '#/definitions/Price'
        description: Amount charged in Billing currency. Tax not included. Is null for future payments
      status:
        $ref: '#/definitions/PaymentStatus'
      extendedStatusInfo:
        $ref: '#/definitions/ExtendedStatusInfo'
      billingAccount:
        type: string
        description: Billing account
  SavingsPlanOrderModelProperties:
    type: object
    description: Savings plan order properties
    properties:
      displayName:
        $ref: '#/definitions/DisplayName'
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
      billingScopeId:
        $ref: '#/definitions/BillingScopeId'
      billingProfileId:
        $ref: '#/definitions/BillingProfileId'
      customerId:
        $ref: '#/definitions/CustomerId'
      billingAccountId:
        $ref: '#/definitions/BillingAccountId'
      term:
        $ref: '#/definitions/Term'
      billingPlan:
        $ref: '#/definitions/BillingPlan'
      expiryDateTime:
        $ref: '#/definitions/ExpiryDateTime'
      benefitStartTime:
        $ref: '#/definitions/BenefitStartTime'
      planInformation:
        $ref: '#/definitions/BillingPlanInformation'
      savingsPlans:
        type: array
        items:
          $ref: '#/definitions/SavingsPlanId'
      extendedStatusInfo:
        $ref: '#/definitions/ExtendedStatusInfo'
  Sku:
    type: object
    description: The SKU to be applied for this resource
    properties:
      name:
        type: string
        description: Name of the SKU to be applied
  PaymentStatus:
    type: string
    description: Describes whether the payment is completed, failed, cancelled or scheduled in the future.
    enum:
    - Succeeded
    - Failed
    - Scheduled
    - Cancelled
    x-ms-enum:
      name: PaymentStatus
      modelAsString: true
  ExtendedStatusInfo:
    type: object
    readOnly: true
    properties:
      statusCode:
        type: string
        description: Status code providing additional information.
      message:
        type: string
        description: The message giving detailed information about the status code.
  Term:
    type: string
    description: Represent benefit term in ISO 8601 format.
    enum:
    - P1Y
    - P3Y
    - P5Y
    x-ms-enum:
      name: Term
      modelAsString: true
  SavingsPlanOrderModelList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SavingsPlanOrderModel'
      nextLink:
        type: string
        description: Url to get the next page.
  CustomerId:
    type: string
    readOnly: true
    description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
  BillingProfileId:
    type: string
    readOnly: true
    description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
  BillingPlan:
    type: string
    description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
    enum:
    - P1M
    x-ms-enum:
      name: BillingPlan
      modelAsString: true
  BillingPlanInformation:
    type: object
    description: Information describing the type of billing plan for this savings plan.
    properties:
      pricingCurrencyTotal:
        $ref: '#/definitions/Price'
        description: Amount of money to be paid for the Order. Tax is not included.
      startDate:
        type: string
        format: date
        description: Date when the billing plan has started.
      nextPaymentDueDate:
        type: string
        format: date
        description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off.
      transactions:
        type: array
        items:
          $ref: '#/definitions/PaymentDetail'
        x-ms-identifiers: []
  SavingsPlanOrderModel:
    type: object
    description: Savings plan order
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      sku:
        description: Savings plan SKU
        $ref: '#/definitions/Sku'
      properties:
        description: Savings plan order properties
        x-ms-client-flatten: true
        $ref: '#/definitions/SavingsPlanOrderModelProperties'
  ExpiryDateTime:
    type: string
    description: Expiry date time
    readOnly: true
    format: date-time
  SavingsPlanId:
    type: string
    description: Identifier of the savings plan
    readOnly: true
  RoleAssignmentEntityProperties:
    type: object
    description: Role assignment entity properties
    properties:
      principalId:
        description: Principal Id
        type: string
      roleDefinitionId:
        description: Role definition id
        type: string
      scope:
        description: Scope of the role assignment entity
        type: string
  BillingAccountId:
    type: string
    readOnly: true
    description: Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers.
  BillingScopeId:
    type: string
    description: Subscription that will be charged for purchasing the benefit
  ProvisioningState:
    type: string
    description: Provisioning state
    readOnly: true
    enum:
    - Creating
    - PendingBilling
    - ConfirmedBilling
    - Created
    - Succeeded
    - Cancelled
    - Expired
    - Failed
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  RoleAssignmentEntity:
    type: object
    description: Role assignment entity
    properties:
      id:
        description: Role assignment entity id
        type: string
      name:
        description: Role assignment entity name
        type: string
      properties:
        description: Role assignment entity properties
        x-ms-client-flatten: true
        $ref: '#/definitions/RoleAssignmentEntityProperties'
  DisplayName:
    type: string
    description: Display name
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    x-ms-parameter-location: client
    required: true
    description: The api-version to be used by the service
    type: string
  SavingsPlanOrderIdParameter:
    name: savingsPlanOrderId
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: Order ID of the savings plan
  ExpandParameter:
    name: $expand
    description: May be used to expand the detail information of some properties.
    in: query
    x-ms-parameter-location: client
    required: false
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'