Grepr Billing API

openapi: 3.2.0
info:
  title: Grepr Billing API
  version: 1.0.0
  description: 'Operations tagged Billing across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Billing
paths:
  /v1/billing/daily-table:
    get:
      description: Returns the daily-usage table for the requested reporting period.
      operationId: getDailyTable
      parameters:
      - description: Canonical period id ("YYYY-MM-DD", the period's start date) for both monthly and annual plans. Defaults to the period containing today when omitted.
        in: query
        name: period
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DailyTable'
            text/csv:
              schema:
                $ref: '#/components/schemas/DailyTable'
          description: Daily-usage table.
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      security:
      - grepr-oidc: []
      summary: Get daily-usage table (JSON or CSV)
      tags:
      - Billing
  /v1/billing/periods:
    get:
      description: Returns the customer display name plus reporting periods available for the authenticated user's organization. Returns 404 when no billing record exists for the customer or no eligible subscription has any closed orders.
      operationId: getPeriods
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingPeriodsResponse'
          description: Customer name + period list.
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      security:
      - grepr-oidc: []
      summary: Get reporting periods + customer display name
      tags:
      - Billing
  /v1/billing/summary:
    get:
      description: Returns the per-period payload — contract bounds, reporting-period descriptor, and plan-specific commitment summary — for the authenticated user's organization. When no period is supplied, defaults to the period containing today.
      operationId: getSummary
      parameters:
      - description: Canonical period id ("YYYY-MM-DD", the period's start date) for both monthly and annual plans. Defaults to the period containing today when omitted.
        in: query
        name: period
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingSummaryResponse'
          description: Contract + reporting period + plan summary.
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No billing record exists, no eligible subscription owns the requested period, or the subscription's plan template is unrecognized.
        '500':
          description: Internal Server Error
      security:
      - grepr-oidc: []
      summary: Get billing summary for one reporting period
      tags:
      - Billing
components:
  schemas:
    AnnualSaasPreCommitmentSummary:
      description: Pre-commitment summary for Annual + SaaS plans.
      properties:
        rows:
          default: []
          description: One row per metric the customer is pre-committed on, ordered by the configured displayed brick id list.
          items:
            $ref: '#/components/schemas/MeteredDimensionCommitment'
          type: array
      required:
      - rows
      type: object
    PaygSummary:
      description: Commitment summary for Monthly + PAYG plans.
      properties:
        chargedThisPeriod:
          description: Invoice total for this reporting period.
          type: number
      type: object
    BillingSummaryResponse:
      description: 'Per-period billing summary: contract bounds, period, summary.'
      properties:
        contract:
          $ref: '#/components/schemas/Contract'
        period:
          $ref: '#/components/schemas/PeriodEntry'
        summary:
          $ref: '#/components/schemas/BillingSummary'
      required:
      - contract
      - period
      - summary
      type: object
    BillingSummary:
      description: Plan-specific usage summary.
      discriminator:
        mapping:
          annual-credit-pool: '#/components/schemas/AnnualCreditPoolSummary'
          annual-data-processing: '#/components/schemas/AnnualDataProcessingSummary'
          annual-saas-pre-commitment: '#/components/schemas/AnnualSaasPreCommitmentSummary'
          monthly-credit-pool: '#/components/schemas/MonthlyCreditPoolSummary'
          monthly-payg: '#/components/schemas/PaygSummary'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/PaygSummary'
      - $ref: '#/components/schemas/MonthlyCreditPoolSummary'
      - $ref: '#/components/schemas/AnnualCreditPoolSummary'
      - $ref: '#/components/schemas/AnnualDataProcessingSummary'
      - $ref: '#/components/schemas/AnnualSaasPreCommitmentSummary'
      properties:
        type:
          type: string
      required:
      - type
      type: object
    BillingPeriodsResponse:
      description: 'Static customer header data for the billing page: display name + selectable reporting periods.'
      properties:
        customerName:
          description: Customer display name (e.g. "ACME, Inc.").
          type: string
        periods:
          default: []
          description: Reporting periods available for this customer, newest first.
          items:
            $ref: '#/components/schemas/PeriodEntry'
          type: array
      required:
      - customerName
      - periods
      type: object
    MonthlyCreditPoolSummary:
      description: Commitment summary for Monthly + Credit Pool plans.
      properties:
        credits:
          description: Monthly recurring committed dollar amount.
          type: number
        total:
          description: Gross consumption in dollars for this reporting period.
          type: number
      required:
      - credits
      - total
      type: object
    AnnualCreditPoolSummary:
      description: Commitment summary for Annual - Credit Pool plans.
      properties:
        annualCommitment:
          description: Yearly committed dollar amount.
          type: number
        usedCumulative:
          description: Cumulative dollar value of consumption since contract start.
          type: number
        usedThisPeriod:
          description: Dollar value of consumption during this reporting period.
          type: number
      required:
      - annualCommitment
      - usedCumulative
      - usedThisPeriod
      type: object
    Contract:
      description: Metadata about the contract.
      properties:
        endDate:
          description: Inclusive contract end date — the last day this contract covers. For renewed or recast contracts, this is the day before the next contract's start.
          format: date
          type: string
        startDate:
          description: Inclusive contract start date.
          format: date
          type: string
      required:
      - endDate
      - startDate
      type: object
    PeriodEntry:
      description: One reporting period — dropdown entry plus bounds for display.
      properties:
        current:
          description: True if this entry's period contains today.
          type: boolean
        endDate:
          description: Inclusive period end date — the last day in the period.
          format: date
          type: string
        id:
          description: Canonical period identifier used in the URL — "YYYY-MM-DD" (the period's start date) for both monthly and annual plans.
          type: string
        startDate:
          description: Inclusive period start date.
          format: date
          type: string
      required:
      - endDate
      - id
      - startDate
      type: object
    AnnualDataProcessingSummary:
      description: Commitment summary for Annual - Data Processing plans.
      properties:
        rows:
          default: []
          description: One row per metric the customer is pre-committed on (e.g. Data Processing GB, Compute Units).
          items:
            $ref: '#/components/schemas/MeteredDimensionCommitment'
          type: array
      required:
      - rows
      type: object
    DailyTable:
      description: Daily-usage table.
      properties:
        current:
          description: True when the reporting period contains today. Same semantic as PeriodEntry.current — the last entry of days[] represents an incomplete day, so consumers should mark it as in-progress.
          type: boolean
        days:
          default: []
          description: The reporting period's days in ascending order.
          items:
            description: The reporting period's days in ascending order.
            format: date
            type: string
          type: array
        metrics:
          default: []
          description: One usage series per metered dimension, in display order. Bricks absent from the configured displayed-brick list are skipped.
          items:
            $ref: '#/components/schemas/MeteredDimensionUsage'
          type: array
      required:
      - days
      - metrics
      type: object
    MeteredDimensionUsage:
      description: One metered dimension's daily usage and period totals.
      properties:
        dailyValues:
          default: []
          description: Per-day usage counts.
          items:
            description: Per-day usage counts.
            type: number
          type: array
        label:
          description: Display label for the metered dimension.
          type: string
        previousMonthTotal:
          description: 'This column''s total for the prior calendar month; null when no prior-month comparison applies (a partial billing cycle, or no prior month before the contract start). Consumers derive the delta and percent change from this value and {@link #getTotal()}.'
          type: number
        total:
          description: Sum of the daily values over the reporting period.
          type: number
        totalDollars:
          description: Billed dollar amount for the period; null when this column has no unit price.
          type: number
      required:
      - dailyValues
      - label
      - total
      type: object
    MeteredDimensionCommitment:
      description: One metric row in a per-metric pre-commitment summary table.
      properties:
        annualCommitment:
          description: Annually committed quantity for this metric.
          type: number
        metric:
          description: Metric name (e.g. "Data Processing GB", "Compute Units").
          type: string
        usedCumulative:
          description: Quantity consumed cumulatively since the contract started.
          type: number
        usedThisPeriod:
          description: Quantity consumed during the reporting period.
          type: number
      required:
      - annualCommitment
      - metric
      - usedCumulative
      - usedThisPeriod
      type: object
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest