Sign in
MembershipTypes

Create MembershipType

Use this endpoint to create a new MembershipType.

post/customers/membership-types

Request body

brand_idstring uuid required

Identifier of the brand that owns this membership type. Membership types are scoped per brand so customers can be enrolled into the same tier across every site that shares the brand.

namestring required

Display name of the membership tier, shown to customers on the storefront, in the membership area, and on email receipts. 1-120 characters and must not contain HTML.

descriptionstring nullable

Marketing description of the membership tier, shown on the storefront purchase page. Use it to summarise the benefits of joining. Plain text, up to 1000 characters.

termsstring nullable

Terms and conditions of the membership type

privateboolean

Whether this MembershipType is private or not.

When a MembershipType is private, it won't be shown to users on the site's shop frontend.

This field is deprecated and has been superceded by visibility.

visibility'public' | 'private' | 'link_only'

The visibility of the MembershipType on the site's shop frontend.

offline_paymentsboolean

Whether this MembershipType takes "offline" payments. If true, the monthly fee won't automatically be collected using Stripe, which can be useful if a different provider is used for collecting direct debits. You'll need to manually manage the membership status.

disable_confirmation_emailboolean

Whether to disable sending the confirmation email when a membership is confirmed.

minimum_start_datestring date-time nullable

The minimum start date for a membership of this type.

min_membersinteger

The minimum number of members required to create a membership of this type

max_membersinteger

The maximum number of members allowed to create a membership of this type

revenue_schedule'FREQ=DAILY' | 'FREQ=WEEKLY' | 'FREQ=MONTHLY;BYMONTHDAY=1'

The revenue schedule for the membership type.

Example request

{
  "name": "Gold tier",
  "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
  "terms": "Membership is non-transferable and subject to a 30-day notice\nperiod for cancellation. See https://example.com/terms for the\nfull agreement.\n",
  "min_members": 2,
  "max_members": 4,
  "initial_rate": {
    "amount": 1000,
    "currency": "GBP"
  }
}

Response

The MembershipType was successfully retrieved

Example response

{
  "data": {
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "default_duration": "P1Y",
        "notice_period": "P1M",
        "private": true
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY"
  }
}

Changes

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