Sign in
MembershipRates

Get totals for a MembershipRate

Returns a breakdown of the total amount a customer will pay to start a membership at this rate over the given period, including any joining fee, pro-rata fee and recurring monthly fee.

get/customers/membership-rates/{rateId}/totals

Query parameters

start_datestring date
Example:2021-02-19

The date the membership will start

end_datestring date
Example:2022-02-19

The date the membership will end

sourcestring
Example:app

The source of the membership

Headers

Accept-Languagestring
Example:en

The language to use for the response.

Response

The membership rate totals were successfully retrieved.

Example response

{
  "data": {
    "total_price": {
      "amount": 6000,
      "currency": "GBP"
    },
    "breakdowns": {
      "joining_fee": {
        "amount": 1000,
        "currency": "GBP"
      },
      "pro_rata_fee": {
        "amount": 1500,
        "currency": "GBP"
      },
      "monthly_fee": {
        "amount": 3000,
        "currency": "GBP"
      }
    },
    "summary_lines": [
      "Your first Direct Debit payment will be taken on **23rd June 2023** for **£30.00**."
    ]
  }
}

Changes

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