---
title: "List Statements"
method: GET
path: "/statements"
tags: ["Statements"]
deprecated: true
---

# List Statements

`GET /statements`

> **Deprecated.**

List statements based on the provided filters

## Query parameters

- `customer_id` string
- `ref_ids` string[]
- `statement_ids` string[]
- `statuses` string[]
- `limit` integer
- `order` 'DESC' | 'ASC'
- `page_cursor` string

## Response `200`

Successfully retrieve statements

- ListStatementsResponse
  - `statements` Statement[]
    - `id` string — Unique statement ID.
    - `ref_id` string — Must be unique per customer.
    - `customer_id` string — UUID of the associated customer.
    - `type` 'STATEMENT_TYPE_UNSPECIFIED' | 'STATEMENT_TYPE_USDG_REWARD'
    - `product` 'USDG_REWARDS'
    - `status` 'STATEMENT_STATUS_UNSPECIFIED' | 'STATEMENT_STATUS_INITIATED' | 'STATEMENT_STATUS_GENERATED' | 'STATEMENT_STATUS_PAID'
    - `metadata` object — Custom fields (e.g., `total_amount`).
    - `statement_balances` StatementBalance[] — Breakdown of owed vs. paid balances.
      - `asset` string
      - `amount_paid` string, decimal
      - `total_amount_owed` string, decimal
      - `next_payment_ref_id` string — next_payment_ref_id should be used by clients as the ref_id when processing payments for statements. This is unique to for each payment that should be submitted. If the amount_paid == total_amount_owed, then this field will be empty.
    - `period_start` string, date-time — The time range this statement covers.
    - `period_end` string, date-time — The time range this statement covers.
    - `generated_at` string, date-time — Lifecycle tracking fields.
    - `paid_at` string, date-time — Lifecycle tracking fields.
    - `created_at` string, date-time — Lifecycle tracking fields.
    - `statement_group_id` string — statement_group_id is used to group multiple statements together. Multiple versions of a statement may belong to a single statement group.
    - `version` integer — Version number of the statement.
    - `files` StatementFile[]
      - `format` string
      - `url` string
      - `expires_at` string, date-time
      - `generated_at` string, date-time
    - `data` BufAny — `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
      - `@type` string — A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
  - `next_page_cursor` string

---

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