---
title: "List projected revenues for memberships"
method: GET
path: "/shop/reports/projected-membership-revenue"
tags: ["Reports"]
---

# List projected revenues for memberships

`GET /shop/reports/projected-membership-revenue`

Use this endpoint to retrieve the projected revenue from `Memberships` at a given date

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `date` string, date, required
- `membership_type_ids` string[]
- `billing_frequency` string[]
- `manual_payments` boolean

## Response `200`

The list of `ProjectedMembershipRevenue` resources was successfully retrieved.

- ListProjectedMembershipRevenueResponse
  - `data` ProjectedMembershipRevenues[], required
    - `id` string, uuid, required — The ID of the membership.
    - `membership_number` string, required — The membership number of the membership.
    - `lead_member` LeadMemberSummary, required — The lead member of a membership
      - `id` string, object-id, required — The ID of the lead member.
      - `full_name` string, required — The full name of the lead member.
      - `email` string, required — The email address of the lead member.
      - `phone` string, required — The phone number of the lead member.
      - `labels` SchemasCustomerLabel3[], required
        - `id` string, uuid, required — The ID of the label
        - `value` string, required — The name of the label
        - `colour` string, required — A hex colour code excluding the preceding \# which this label will be rendered as.
    - `start_date` string, datetime, required — The start date of the membership.
    - `end_date` string, datetime, required — The end date of the membership.
    - `membership_type` MembershipTypeSummary, required — A summary of a membership type.
      - `id` string, object-id, required — The ID of the membership type.
      - `name` string, required — The name of the membership type.
    - `membership_rate` MembershipRateSummary, required — A summary of a membership rate.
      - `id` string, object-id, required — The ID of the membership rate.
      - `name` string, required — The name of the membership rate.
    - `status` 'active' | 'needs_dd_mandate' | 'needs_attention' | 'reserved' | 'inactive' | 'expired' | 'upcoming', required — The status of the membership
    - `gross_amount` integer, required — The gross amount of the membership.
    - `net_amount` integer, required — The net amount of the membership.
    - `duration_days` integer, required — The duration of the membership in days.
    - `elapsed_days` integer, required — The number of days elapsed since the membership started.
    - `remaining_days` integer, required — The number of days remaining until the membership ends.
    - `gross_remaining_balance` integer, required — The gross remaining balance of the membership.
    - `net_remaining_balance` integer, required — The net remaining balance of the membership.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)