openapi: 3.2.0
info:
  title: Magnite Bills API
  version: '1.0'
  description: 'Operations tagged Bills across 2 of this provider''s published API definitions: magnite-springserve-v0-openapi.yml, magnite-springserve-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://console.springserve.com
  description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
- url: https://api.springserve.com
  description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
security:
- api_key: []
- bearer_token: []
tags:
- name: Bills
paths:
  /api/v0/bills:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Bills
      operationId: bills_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_create_simple:
                $ref: '#/components/examples/bill_create_simple'
              bill_create_full:
                $ref: '#/components/examples/bill_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/bills/{id}:
    get:
      summary: Show
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_id_get
    put:
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_update_simple:
                $ref: '#/components/examples/bill_update_simple'
              bill_update_full:
                $ref: '#/components/examples/bill_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_id_put
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/bills/{bill_id}/bill_items:
    get:
      summary: Index
      description: List bill items for a bill
      parameters:
      - name: bill_id
        in: path
        required: true
        schema:
          type: string
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Bills
      operationId: bills_bill_id_bill_items_get
    post:
      summary: Create
      parameters:
      - name: bill_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_item_create_simple:
                $ref: '#/components/examples/bill_item_create_simple'
              bill_item_create_full:
                $ref: '#/components/examples/bill_item_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_bill_id_bill_items_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/bills/{bill_id}/bill_items/{id}:
    parameters:
    - name: bill_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Show
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_bill_id_bill_items_id_get
    put:
      summary: Update
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_item_update_simple:
                $ref: '#/components/examples/bill_item_update_simple'
              bill_item_update_full:
                $ref: '#/components/examples/bill_item_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Bills
      operationId: bills_bill_id_bill_items_id_put
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/bills:
    get:
      summary: Index
      tags:
      - Bills
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/sortParam
      - $ref: ref/params.yaml#/components/parameters/searchParam
      - $ref: ref/params.yaml#/components/parameters/filterParams
      - $ref: ref/params.yaml#/components/parameters/includeParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                  - $ref: '#/components/schemas/Bill'
      operationId: bills_get
    post:
      summary: Create
      tags:
      - Bills
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_create_simple:
                $ref: '#/components/examples/bill_create_simple'
              bill_create_full:
                $ref: '#/components/examples/bill_create_full_2'
        required: true
      responses:
        '201':
          description: Successfully created a new bill
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bill'
        '422':
          description: Unprocessable request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                examples:
                - error: Name can't be blank
                  errors:
                    name:
                    - can't be blank
      operationId: bills_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/bills/{id}:
    get:
      summary: Show
      tags:
      - Bills
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bill'
      operationId: bills_id_get
    patch:
      summary: Update
      tags:
      - Bills
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              bill_update_simple:
                $ref: '#/components/examples/bill_update_simple'
              bill_update_full:
                $ref: '#/components/examples/bill_update_full_2'
        required: true
      responses:
        '200':
          description: Successfully updated a bill
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bill'
        '422':
          description: Unprocessable request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                examples:
                - error: Name can't be blank
                  errors:
                    name:
                    - can't be blank
      operationId: bills_id_patch
    delete:
      summary: Delete
      tags:
      - Bills
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      operationId: bills_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/bills/permissions:
    get:
      summary: Collection Permissions
      tags:
      - Bills
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      operationId: bills_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/bills/{id}/permissions:
    get:
      summary: Permissions Member
      tags:
      - Bills
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      operationId: bills_id_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
components:
  examples:
    bill_update_simple:
      summary: Simple
      value:
        name: Bill Name
    bill_item_update_simple:
      summary: Simple
      value:
        label: Bill Item Label
        unit_cost: 1.11
    bill_item_create_full:
      summary: Full
      value:
        label: Bill Item Label
        other_account_id: 1
        unit_cost: 1.11
        units: 1.11
        total_cost: 1.11
        xero_account_code: 401
        is_unit_cost_cpm: true
        is_synced: false
    bill_item_update_full:
      summary: Full
      value:
        label: Bill Item Label
        other_account_id: 1
        unit_cost: 1.11
        units: 1.11
        total_cost: 1.11
        xero_account_code: 401
        is_unit_cost_cpm: true
        is_synced: false
    bill_update_full:
      summary: Full
      value:
        name: Bill Name
        month: '2026-01-01'
        currency: USD
        is_invoice: false
        is_direct_connect: false
        is_openrtb: false
    bill_item_create_simple:
      summary: Simple
      value:
        label: Bill Item Label
        unit_cost: 1.11
        units: 1.11
        total_cost: 1.11
    bill_create_full:
      summary: Full
      value:
        name: Bill Name
        month: '2026-01-01'
        currency: USD
        is_invoice: false
        is_direct_connect: false
        is_openrtb: false
    bill_create_simple:
      summary: Simple
      value:
        name: Bill Name
        month: '2026-01-01'
        currency: USD
        is_invoice: false
        is_direct_connect: false
        is_openrtb: false
    bill_update_full_2:
      summary: Full
      value:
        name: Bill Name
        month: '2026-01-01'
        currency: USD
        is_invoice: false
        is_direct_connect: false
        is_openrtb: false
        is_finalized: false
    bill_create_full_2:
      summary: Full
      value:
        name: Bill Name
        month: '2026-01-01'
        currency: USD
        is_invoice: false
        is_direct_connect: false
        is_openrtb: false
        is_finalized: false
  schemas:
    Bill:
      type: object
      properties:
        id:
          type: number
        account_id:
          type: number
        name:
          type: string
        month:
          type: string
        is_finalized:
          type: boolean
        is_invoice:
          type: boolean
        is_direct_connect:
          type: boolean
        is_openrtb:
          type: boolean
        currency:
          type: string
        total_bill_amount:
          type: number
        total_amount_collected:
          type: number
        bill_items_count:
          type: number
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth
x-refined-from:
- magnite-springserve-v0-openapi.yml
- magnite-springserve-v1-openapi.yml