---
title: "List Addendums"
method: GET
path: "/billing/org/v1/addendums"
tags: ["addendums"]
---

# List Addendums

`GET /billing/org/v1/addendums`

Retrieve a list of `Addendum` objects.

You can use query parameters to filter, sort, and paginate the results.

## Query parameters

- `active_after` string, date-time
- `active_at` string, date-time
- `active_before` string, date-time
- `active_end_from` string, date-time
- `active_end_to` string, date-time
- `active_start_from` string, date-time
- `active_start_to` string, date-time
- `addendum_id` string[]
- `client_id` integer[]
- `company_name` string
- `created_after` string, date-time
- `created_before` string, date-time
- `created_on` string, date
- `currency_char_code` string[]
- `currency_id` integer[]
- `id` integer
- `limit` integer
- `not_active_at` string, date-time
- `offset` integer
- `ordering` string[]
- `payer_id` integer[]
- `plan_id` integer[]
- `plan_name` string
- `product_id` integer[]
- `product_internal_name` string[]
- `product_name` string
- `provider_id` integer[]
- `reseller_id` integer
- `status` string[]

## Response `200`

Request successful.

- PaginatedAddendumForOrgSerializerV1List
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` AddendumForOrgSerializerV1[], required
    - `id` integer, required
    - `client_id` integer, required — The ID of the client associated with the addendum.
    - `client` CustomerPayerCommonShort, required
      - `id` integer, required
      - `company_name` string, required
    - `status` 'upcoming' | 'active' | 'paused' | 'stopped', required — Addendum status - `upcoming` - upcoming - `active` - active - `paused` - paused - `stopped` - stopped
    - `active_range` DateTimeTZRange, required — Date-time range with start and end fields.
      - `start` string, date-time, nullable
      - `end` string, date-time, nullable
    - `created_at` string, date-time, required — Date of current addendum creation
    - `currency` CurrencyCommonShort, required
      - `id` integer, required
      - `char_code` string, required — Currency iso4217 char code
      - `symbol` string, nullable — Currency symbol, for example '$'
    - `plan` PlanCommonShort, required
      - `id` integer, required
      - `name` string, required
    - `product` ProductCommonShort, required
      - `id` integer, required
      - `name` string, required
      - `internal_name` string, required
    - `status_at_active_at` string, nullable, required — Status of the addendum at the requested `active_at` time. This field is not present by default, but it can be requested by passing the `active_at` query parameter.

## Other responses

- `401` — Authentication credentials were not provided or are invalid.
- `403` — You do not have permission to perform this action.

---

[API](https://skmtc.dev/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.dev/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)