Reports

List projected revenues for memberships

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

get/shop/reports/projected-membership-revenue

Query parameters

site_idstring uuid required

Filter the projected membership revenue report by site

pageinteger

The page to retrieve results from

datestring date required

Example:2023-05-05

The date to get the projected membership revenue report for

membership_type_idsstring[]

Filter the projected membership revenue report by membership type

billing_frequencystring[]

Filter the projected membership revenue report by billing frequency

manual_paymentsboolean

Filter the projected membership revenue report by manual payments

Response

The list of ProjectedMembershipRevenue resources was successfully retrieved.

Example response

{
  "data": [
    {
      "membership_number": "00000014",
      "lead_member": {
        "labels": [
          {
            "value": "VIP",
            "colour": "ff6634"
          }
        ]
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.