List membership plans

Facade over membership plans and their fees (the Product STI is hidden). Needs products.read.

GET/membership_plans

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

shop_idinteger

statestring

Allowed:visiblehidden

qstring

Plan name (substring).

pageinteger

default: 1

per_pageinteger

default: 30

Responses

200

Plans: { id, name, description, state, max_seats, currency_code, fees [{ id, payment_interval, setup_fee, renewal_fee, payment_day, total_payments }], accessible_product_ids, permissions { pause_intervals, allows_edit, allows_reenable, manage_seats }, active_purchases_count }. Money in cents; total_payments -1 is unlimited.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idquerystatequeryqqueryPlan name (substring).pagequeryper_pagequery

Request

curl -X GET 'https://api.onbolder.com/v2/membership_plans' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.onbolder.com/v2/membership_plans", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/membership_plans",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

Plans: `{ id, name, description, state, max_seats, currency_code, fees [{ id, payment_interval, setup_fee, renewal_fee, payment_day, total_payments }], accessible_product_ids, permissions { pause_intervals, allows_edit, allows_reenable, manage_seats }, active_purchases_count }`. Money in cents; `total_payments` -1 is unlimited.