---
title: "GET /billing/batches"
method: GET
path: "/billing/batches"
tags: ["Streams"]
---

# GET /billing/batches

`GET /billing/batches`

## Query parameters

- `limit` integer
- `offset` integer
- `context` string
- `context.period.end` string, date-time
- `context.period.start` string, date-time
- `events` string
- `events.created.at` string, date-time
- `id` string
- `name` string
- `source.id` string
- `stats` string
- `status` 'draft' | 'processing' | 'published' | 'failed' | 'deleted'
- `stream.context` string
- `stream.context.account.id` string
- `stream.context.account.name` string
- `stream.context.listing.id` string
- `stream.context.marketplace.id` string
- `stream.context.marketplace.name` string
- `stream.context.product.id` string
- `stream.context.product.name` string
- `stream.id` string
- `stream.owner.id` string
- `task.status` 'pending' | 'processing' | 'success' | 'failed'
- `test` boolean

## Response `200`

- StreamsBillingBatch[]
  - `id` string
  - `name` string, required
  - `external_id` string, nullable
  - `status` 'draft' | 'processing' | 'published' | 'failed' | 'deleted'
  - `description` string, nullable
  - `stream` StreamsBillingExtendedStreamReference, required
    - `id` string
    - `name` string, required
    - `status` 'configuring' | 'active' | 'terminated' | 'deleted'
    - `owner` StreamsAccountReference
      - `id` string, required
      - `name` string, required
      - `icon` string, nullable
    - `context` StreamsBillingStreamContext, required
      - `account` StreamsAccountReference, required
        - `id` string, required
        - `name` string, required
        - `icon` string, nullable
      - `product` StreamsProductReference, required
        - `id` string, required
        - `name` string, required
        - `icon` string, nullable
      - `marketplace` StreamsMarketplaceReference, required
        - `id` string, required
        - `name` string, required
        - `icon` string, nullable
        - `currency` string, nullable
      - `listing` StreamsListingReference, required
        - `id` string, required
  - `source` StreamsBatchReference, required
    - `id` string
    - `name` string, required
    - `status` 'draft' | 'processing' | 'published' | 'failed' | 'deleted'
  - `test` boolean, required
  - `error` string, nullable
  - `task` StreamsTask, required
    - `name` string, required
    - `status` 'pending' | 'processing' | 'success' | 'failed'
    - `error` StreamsTaskError, required
      - `message` unknown
  - `stats` object
    - `requests` object
      - `total` integer
      - `processed` number
  - `events` object
    - `created` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `updated` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `processing` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `processed` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `published` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
  - `stream_updated` string
  - `context` StreamsBillingBatchContext, required
    - `period` StreamsBillingPeriod, required
      - `start` string, date-time, required
      - `end` string, date-time, required

## Other responses

- `400`

---

[API](https://skmtc.net/cloudblue/apis/cloudblue-connect-api.md) · [All operations](https://skmtc.net/cloudblue/apis/cloudblue-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudblue/cloudblue-connect-api/revisions/0421d2a97c52/schema)