Vultr Billing API

openapi: 3.2.0
info:
  title: Vultr Billing API
  version: '2.0'
  description: 'Operations tagged billing across 3 of this provider''s published API definitions: vultr-schema-openapi.json, vultr-v2-openapi.yaml, vultr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vultr.com/v2
security:
- API Key: []
tags:
- name: Billing
  x-displayName: Billing
  description: Read-only billing information for your user account.
paths:
  /billing/history:
    parameters: []
    get:
      summary: List Billing History
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  billing_history:
                    $ref: '#/components/schemas/billing'
                  meta:
                    $ref: '#/components/schemas/meta'
              examples:
                example-1:
                  value:
                    billing_history:
                    - id: 123456
                      date: '2020-10-10T01:56:20+00:00'
                      type: invoice
                      description: 'Invoice #123456'
                      amount: 100.03
                      balance: 79.48
                    - id: 123457
                      date: '2020-10-10T01:46:05+00:00'
                      type: credit
                      description: Account Credit
                      amount: 50.55
                      balance: -20.55
                    meta:
                      total: 3
                      links:
                        next: WxYzExampleNext
                        prev: ''
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        ? ''
        : content:
            application/json:
              schema:
                type: object
                properties:
                  billing:
                    $ref: ''
      operationId: list-billing-history
      description: Retrieve list of billing history
      security:
      - API Key: []
      tags:
      - Billing
      x-codeSamples:
      - lang: Curl
        source: "curl \"https://api.vultr.com/v2/billing/history\" \\\n  -X GET \\\n  -H \"Authorization: Bearer ${VULTR_API_KEY}\""
    servers:
    - url: https://api.vultr.com/v2
  /billing/invoices:
    parameters: []
    get:
      summary: List Invoices
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: ''
                type: object
                x-examples:
                  example-1:
                    billing_invoice:
                    - id: 123456
                      billing_period: 09-01-2021
                      amount: 5
                properties:
                  billing_invoices:
                    type: array
                    items:
                      $ref: '#/components/schemas/invoice'
                  meta:
                    $ref: '#/components/schemas/meta'
              examples:
                example-1:
                  value:
                    billing_invoices:
                    - id: 123456
                      date: '2021-10-10T00:00:00+00:00'
                      description: 'Invoice #123456'
                      amount: 5.25
                      balance: 10.25
                    meta:
                      total: 1
                      links:
                        next: ''
                        prev: ''
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        ? ''
        : content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: ''
              examples:
                example-1:
                  billing_history: null
      operationId: list-invoices
      description: Retrieve full specified invoice
      security:
      - API Key: []
      tags:
      - Billing
      x-codeSamples:
      - lang: Curl
        source: "curl \"https://api.vultr.com/v2/billing/invoices/{invoice-id}\" \\\n  -X GET \\\n  -H \"Authorization: Bearer ${VULTR_API_KEY}\""
    servers:
    - url: https://api.vultr.com/v2
  /billing/invoices/{invoice-id}:
    parameters:
    - schema:
        type: string
      name: invoice-id
      in: path
      required: true
    get:
      summary: Get Invoice
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: ''
                type: object
                x-examples:
                  example-1:
                    billing_invoice:
                      id: 123456
                      description: Account Credit
                      billing_period: 09-01-2021
                      amount: 5
                properties:
                  billing_invoice:
                    $ref: '#/components/schemas/invoice'
              examples:
                example-1:
                  value:
                    billing_invoice:
                      id: 123456
                      description: Account Credit
                      date: 09-01-2021T00:00:00+00:00
                      amount: 5.25
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        ? ''
        : content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: ''
              examples:
                example-1:
                  billing_history: null
      operationId: get-invoice
      description: Retrieve specified invoice
      security:
      - API Key: []
      tags:
      - Billing
      x-codeSamples:
      - lang: Curl
        source: "curl \"https://api.vultr.com/v2/billing/invoices/{invoice-id}\" \\\n  -X GET \\\n  -H \"Authorization: Bearer ${VULTR_API_KEY}\""
    servers:
    - url: https://api.vultr.com/v2
  /billing/invoices/{invoice-id}/items:
    parameters:
    - schema:
        type: string
      name: invoice-id
      in: path
      required: true
    get:
      summary: Get Invoice Items
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: ''
                type: object
                x-examples:
                  example-1:
                    invoice_items:
                    - description: Load Balancer (my-loadbalancer)
                      product: Load Balancer
                      start_date: '2021-08-31 20:00:00'
                      end_date: '2021-09-30 20:00:00'
                      units: 720
                      unit_type: hours
                      unit_price: 0.0149
                      total: 10
                    - description: 1.1.1.1 (8192 MB) [my-instance]
                      product: Vultr Cloud Compute
                      start_date: '2021-09-15 09:13:15'
                      end_date: '2021-09-30 20:00:00'
                      units: 371
                      unit_type: hours
                      unit_price: 0.0595
                      total: 22.09
                    meta:
                      total: 3
                      links:
                        next: WxYzExampleNext
                        prev: ''
                properties:
                  invoice_items:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                          description: Invoice item description
                        product:
                          type: string
                          description: Product name
                        start_date:
                          type: string
                          description: Start date of item
                        end_date:
                          type: string
                          description: End date of item
                        units:
                          type: number
                          description: Number of units item consumed in billing period
                        unit_type:
                          type: string
                          description: Unit type. Options include "hours", "overage", and "discount"
                        unit_price:
                          type: number
                          description: Price per unit in dollars
                        total:
                          type: number
                          description: Total amount due in dollars
                  meta:
                    type: object
                    properties:
                      total:
                        type: number
                      links:
                        type: object
                        properties:
                          next:
                            type: string
                          prev:
                            type: string
              examples:
                example-1:
                  value:
                    invoice_items:
                    - description: Load Balancer (my-loadbalancer)
                      product: Load Balancer
                      start_date: '2021-08-31T00:00:00+00:00'
                      end_date: '2021-09-30T00:00:00+00:00'
                      units: 720
                      unit_type: hours
                      unit_price: 0.0149
                      total: 10
                    - description: 1.1.1.1 (8192 MB) [my-instance]
                      product: Vultr Cloud Compute
                      start_date: '2021-09-15T00:00:00+00:00'
                      end_date: '2021-09-30T00:00:00+00:00'
                      units: 371
                      unit_type: hours
                      unit_price: 0.0595
                      total: 22.09
                    meta:
                      total: 3
                      links:
                        next: WxYzExampleNext
                        prev: ''
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        ? ''
        : content:
            application/json:
              schema:
                type: object
                properties:
                  invoice:
                    $ref: ''
              examples:
                example-1:
                  billing_history: null
      operationId: get-invoice-items
      description: Retrieve full specified invoice
      security:
      - API Key: []
      tags:
      - Billing
      x-codeSamples:
      - lang: Curl
        source: "curl \"https://api.vultr.com/v2/billing/invoices/{invoice-id}/items\" \\\n  -X GET \\\n  -H \"Authorization: Bearer ${VULTR_API_KEY}\""
    servers:
    - url: https://api.vultr.com/v2
components:
  schemas:
    invoice:
      title: invoice
      type: object
      x-examples:
        example-1:
          id: 123456
          date: '2021-11-02T00:48:13+00:00'
          description: 'Invoice #132456'
          amount: 0.25
          balance: -197.88
      properties:
        id:
          type: integer
          description: ID of the invoice
        date:
          type: string
          description: Date invoice was generated
        description:
          type: string
          description: description of item
        amount:
          type: number
          description: Amount due in dollars
        balance:
          type: number
          description: Account balance amount in dollars
    meta:
      title: meta
      type: object
      x-examples:
        meta response:
          meta:
            total: 31
            links:
              next: WxYzExampleNext
              prev: ''
      description: The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.
      properties:
        total:
          type: integer
          description: Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set.
        links:
          type: object
          description: Cursor values for pagination.
          properties:
            next:
              type: string
              description: Cursor value for the next page.
            prev:
              type: string
              description: Cursor value for the previous page.
    billing:
      description: ''
      type: object
      x-examples:
        example-1:
          id: 123456
          date: '2020-10-10T01:56:20+00:00'
          type: invoice
          description: 'Invoice #123456'
          amount: 100.25
          balance: 100.25
      x-tags:
      - billing
      properties:
        id:
          type: number
          description: ID of the billing history item
        date:
          type: string
          description: Date billing history item was generated
        type:
          type: string
          description: Type of billing history item
        description:
          type: string
          description: Description of billing history item
        amount:
          type: number
          description: Amount for the billing history item in dollars
        balance:
          type: number
          description: The accounts balance in dollars
    list_billing_history_200_response:
      example:
        billing_history:
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0.8008281904610115
          type: type
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0.8008281904610115
          type: type
        meta:
          total: 0
          links:
            next: next
            prev: prev
      properties:
        billing_history:
          description: List of all billing history.
          items:
            $ref: '#/components/schemas/billing_2'
          type: array
        meta:
          $ref: '#/components/schemas/meta_2'
      type: object
    invoice_2:
      example:
        date: date
        amount: 6.027456183070403
        balance: 1.4658129805029452
        description: description
        id: 0
      properties:
        id:
          description: ID of the invoice
          type: integer
        date:
          description: Date invoice was generated
          type: string
        description:
          description: description of item
          type: string
        amount:
          description: Amount due in dollars
          type: number
        balance:
          description: Account balance amount in dollars
          type: number
      title: invoice
      type: object
      x-examples:
        example-1:
          id: 123456
          date: 2021-11-02 00:48:13+00:00
          description: 'Invoice #132456'
          amount: 0.25
          balance: -197.88
    meta_2:
      description: The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.
      example:
        total: 0
        links:
          next: next
          prev: prev
      properties:
        total:
          description: Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set.
          type: integer
        links:
          $ref: '#/components/schemas/meta_links'
      title: meta
      type: object
      x-examples:
        meta response:
          meta:
            total: 31
            links:
              next: WxYzExampleNext
              prev: ''
    get_invoice_items_200_response:
      description: ''
      example:
        invoice_items:
        - end_date: end_date
          product: product
          total: 1.4658129805029452
          description: description
          units: 0.8008281904610115
          unit_type: unit_type
          unit_price: 6.027456183070403
          start_date: start_date
        - end_date: end_date
          product: product
          total: 1.4658129805029452
          description: description
          units: 0.8008281904610115
          unit_type: unit_type
          unit_price: 6.027456183070403
          start_date: start_date
        meta:
          total: 5.962133916683182
          links:
            next: next
            prev: prev
      properties:
        invoice_items:
          description: List of invoice items.
          items:
            $ref: '#/components/schemas/get_invoice_items_200_response_invoice_items_inner'
          type: array
        meta:
          $ref: '#/components/schemas/get_invoice_items_200_response_meta'
      type: object
      x-examples:
        example-1:
          invoice_items:
          - description: Load Balancer (my-loadbalancer)
            product: Load Balancer
            start_date: 2021-08-31 20:00:00
            end_date: 2021-09-30 20:00:00
            units: 720
            unit_type: hours
            unit_price: 0.0149
            total: 10
          - description: 1.1.1.1 (8192 MB) [my-instance]
            product: Vultr Cloud Compute
            start_date: 2021-09-15 09:13:15
            end_date: 2021-09-30 20:00:00
            units: 371
            unit_type: hours
            unit_price: 0.0595
            total: 22.09
          meta:
            total: 3
            links:
              next: WxYzExampleNext
              prev: ''
    billing_2:
      description: Invoice
      example:
        date: date
        amount: 6.027456183070403
        balance: 1.4658129805029452
        description: description
        id: 0.8008281904610115
        type: type
      properties:
        id:
          description: ID of the billing history item
          type: number
        date:
          description: Date billing history item was generated
          type: string
        type:
          description: Type of billing history item
          type: string
        description:
          description: Description of billing history item
          type: string
        amount:
          description: Amount for the billing history item in dollars
          type: number
        balance:
          description: The accounts balance in dollars
          type: number
      title: billing
      type: object
      x-examples:
        example:
          id: 123456
          date: 2020-10-10 01:56:20+00:00
          type: invoice
          description: 'Invoice #123456'
          amount: 100.25
          balance: 100.25
      x-tags:
      - billing
    list_invoices_200_response:
      description: ''
      example:
        meta:
          total: 0
          links:
            next: next
            prev: prev
        billing_invoices:
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
      properties:
        billing_invoices:
          description: List of billing invoices.
          items:
            $ref: '#/components/schemas/invoice_2'
          type: array
        meta:
          $ref: '#/components/schemas/meta_2'
      type: object
      x-examples:
        example-1:
          billing_invoice:
          - id: 123456
            billing_period: 09-01-2021
            amount: 5
    get_invoice_items_200_response_invoice_items_inner:
      example:
        end_date: end_date
        product: product
        total: 1.4658129805029452
        description: description
        units: 0.8008281904610115
        unit_type: unit_type
        unit_price: 6.027456183070403
        start_date: start_date
      properties:
        description:
          description: Invoice item description
          type: string
        product:
          description: Product name
          type: string
        start_date:
          description: Start date of item
          type: string
        end_date:
          description: End date of item
          type: string
        units:
          description: Number of units item consumed in billing period
          type: number
        unit_type:
          description: Unit type. Options include "hours", "overage", and "discount"
          type: string
        unit_price:
          description: Price per unit in dollars
          type: number
        total:
          description: Total amount due in dollars
          type: number
      type: object
    get_invoice_200_response:
      description: ''
      example:
        billing_invoice:
          date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
      properties:
        billing_invoice:
          $ref: '#/components/schemas/invoice_2'
      type: object
      x-examples:
        example-1:
          billing_invoice:
            id: 123456
            description: Account Credit
            billing_period: 09-01-2021
            amount: 5
    get_invoice_items_200_response_meta:
      example:
        total: 5.962133916683182
        links:
          next: next
          prev: prev
      properties:
        total:
          type: number
        links:
          $ref: '#/components/schemas/get_invoice_items_200_response_meta_links'
      type: object
    meta_links:
      description: Cursor values for pagination.
      example:
        next: next
        prev: prev
      properties:
        next:
          description: Cursor value for the next page.
          type: string
        prev:
          description: Cursor value for the previous page.
          type: string
      type: object
    get_invoice_items_200_response_meta_links:
      example:
        next: next
        prev: prev
      properties:
        next:
          type: string
        prev:
          type: string
      type: object
    list_billing_history_200_response_2:
      example:
        billing_history:
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0.8008281904610115
          type: type
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0.8008281904610115
          type: type
        meta:
          total: 0
          links:
            next: next
            prev: prev
      properties:
        billing_history:
          description: List of all billing history.
          items:
            $ref: '#/components/schemas/billing_3'
          type: array
        meta:
          $ref: '#/components/schemas/meta_3'
      type: object
    invoice_3:
      example:
        date: date
        amount: 6.027456183070403
        balance: 1.4658129805029452
        description: description
        id: 0
      properties:
        id:
          description: ID of the invoice
          type: integer
        date:
          description: Date invoice was generated
          type: string
        description:
          description: description of item
          type: string
        amount:
          description: Amount due in dollars
          type: number
        balance:
          description: Account balance amount in dollars
          type: number
      title: invoice
      type: object
      x-examples:
        example-1:
          id: 123456
          date: 2021-11-02 00:48:13+00:00
          description: 'Invoice #132456'
          amount: 0.25
          balance: -197.88
    meta_3:
      description: The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.
      example:
        total: 0
        links:
          next: next
          prev: prev
      properties:
        total:
          description: Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set.
          type: integer
        links:
          $ref: '#/components/schemas/meta_links'
      title: meta
      type: object
      x-examples:
        meta response:
          meta:
            total: 31
            links:
              next: WxYzExampleNext
              prev: ''
    billing_3:
      description: Invoice
      example:
        date: date
        amount: 6.027456183070403
        balance: 1.4658129805029452
        description: description
        id: 0.8008281904610115
        type: type
      properties:
        id:
          description: ID of the billing history item
          type: number
        date:
          description: Date billing history item was generated
          type: string
        type:
          description: Type of billing history item
          type: string
        description:
          description: Description of billing history item
          type: string
        amount:
          description: Amount for the billing history item in dollars
          type: number
        balance:
          description: The accounts balance in dollars
          type: number
      title: billing
      type: object
      x-examples:
        example:
          id: 123456
          date: 2020-10-10 01:56:20+00:00
          type: invoice
          description: 'Invoice #123456'
          amount: 100.25
          balance: 100.25
      x-tags:
      - billing
    list_invoices_200_response_2:
      description: ''
      example:
        meta:
          total: 0
          links:
            next: next
            prev: prev
        billing_invoices:
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
        - date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
      properties:
        billing_invoices:
          description: List of billing invoices.
          items:
            $ref: '#/components/schemas/invoice_3'
          type: array
        meta:
          $ref: '#/components/schemas/meta_3'
      type: object
      x-examples:
        example-1:
          billing_invoice:
          - id: 123456
            billing_period: 09-01-2021
            amount: 5
    get_invoice_200_response_2:
      description: ''
      example:
        billing_invoice:
          date: date
          amount: 6.027456183070403
          balance: 1.4658129805029452
          description: description
          id: 0
      properties:
        billing_invoice:
          $ref: '#/components/schemas/invoice_3'
      type: object
      x-examples:
        example-1:
          billing_invoice:
            id: 123456
            description: Account Credit
            billing_period: 09-01-2021
            amount: 5
  securitySchemes:
    API_Key:
      type: http
      scheme: bearer
      in: header
      description: "The Vultr API v2 uses API keys for authentication. You can manage your API keys in the Vultr customer portal. Please do not share API keys publicly, or embed them in client-side code. It is a good security practice to restrict their use by IP address in the [customer portal](https://my.vultr.com/settings/#settingsapi).\n\nTo authenticate a request, send your API Key as a bearer token in the request header.\n\n### Authentication Example\n\n    curl \"https://api.vultr.com/v2/account\" \\\n      -X GET \\\n      -H \"Authorization: Bearer ${VULTR_API_KEY}\"\n\nUnauthenticated API requests will fail. All requests must use HTTPS encryption for security, and calls made with HTTP will fail."
x-refined-from:
- vultr-schema-openapi.json
- vultr-v2-openapi.yaml
- vultr-openapi.yml