Sign in
Memberships

Get new-membership signup details

Returns the data needed to render the public, unauthenticated "join a membership" form for a given site: the membership types on offer, the public rates under each type, and (if a MembershipSignupToken is supplied via token) the pre-filled customer details and / or the single membership type or rate the token has been narrowed to.

Rates include their joining fee, recurring price and a calculated pro-rata amount for an immediate signup based on the current date — this is what a self-signup checkout page should display side-by-side with the recurring price.

Membership types are filtered to those visible on the supplied site's brand and that have at least one public rate (unless a token overrides the visibility). Membership types without public rates are silently omitted; if a token is supplied and constrains the type or rate, only that subset is returned.

This endpoint is public — no authentication is required, since it powers the storefront's "Become a member" page.

get/customers/new-membership

Query parameters

site_idstring required

Filter results by the site they belong to

tokenstring uuid

Optional MembershipSignupToken ID. When present, the response is narrowed to the membership type and / or rate that the token is scoped to, and the customer_details field is populated with any pre-filled name / email / phone the token carries — typically used to deep-link a personalised signup URL from a marketing email.

Response

The signup form details were successfully retrieved.

Example response

{
  "types": [
    {
      "name": "Gold tier",
      "rates": [
        {
          "name": "Standard rate",
          "currency": "GBP",
          "price": 3000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "notice_period": "P1M",
          "pro_rata": 1500
        }
      ]
    }
  ]
}

Changes