API referencePlan comparison

Plan comparison

1 operation. Every schema and example on this page is generated from the platform contract.

What the plan a business can join includes, feature by feature.

The package table on the merchant signup page. Public, because it is read before anyone has an account. A shop that is not a gym has one plan, Every feature included; buyers may pay a booking fee on online orders and deposits. Rendered from plan_entitlements joined to feature labels, never from a hand-kept feature list per tier.

auth none, publicop getPlanComparisonrate limitederrors

Response, 200

plansarray of objectrequired

The columns, in display order.

6 child fields
idstringrequired

The plan, e.g. "member" (Local, the one plan for a shop that is not a gym).

namestringrequired

What the plan is called on screen, e.g. "Local".

displayPricestringrequired

Monthly price per location as shown, e.g. "£0".

displaySetupFeestringrequired

One-time setup fee as shown, e.g. "£0".

withdrawnbooleanrequired

True when the plan still renews for existing merchants but cannot be bought by a new one.

recommendedbooleanrequired

The plan presented as the default choice.

featuresarray of objectrequired

The rows, one per entitlement key.

5 child fields
keystringrequired

The entitlement key, e.g. "can_use_wallet_passes".

labelstringrequired

Human-readable feature name.

descriptionstringrequired

One line on what the feature does.

addOnstring, nullablerequired

Add-on slug when the feature is switched on separately rather than granted by the plan, else null (some add-ons are free, e.g. bookings). Such a feature is correctly false on every plan, that is not the same as unavailable.

cellsobjectrequired

plan id → whether that plan grants this feature, read from plan_entitlements.enabled for the rows the plan resolves to (Local reads the rows every non-gym shop resolves).

shapeobjectrequired

The measured shape, so a caller can assert on it instead of trusting a number in a doc.

2 child fields
featuresnumberrequired

Number of feature rows returned.

plansnumberrequired

Number of plan columns returned.

curl -G "https://www.membber.com/api/v1/plan-comparison"
Response, 200
{
  "plans": [
    {
      "id": "00000d1b-0000-4000-8000-d0c500000000",
      "name": "Example name",
      "displayPrice": "<displayPrice>",
      "displaySetupFee": "<displaySetupFee>",
      "withdrawn": true,
      "recommended": true
    }
  ],
  "features": [
    {
      "key": "<key>",
      "label": "<label>",
      "description": "Added at the front desk",
      "addOn": "<addOn>",
      "cells": {}
    }
  ],
  "shape": {
    "features": 1,
    "plans": 1
  }
}
WhatsApp
Book a Call
Get Started
Plan comparison API | Membber Developers