Memberships

Membership Types

A MembershipType represents a type of membership. This encompasses the credits which the member receives.

The MembershipType object

Attributes

iduuidrequired
The ID of the membership type
namestringrequired
The name of the membership type
descriptionstringrequirednullable
The description of the membership type
termsstringrequirednullable
Terms and conditions of the membership type
brand_iduuidrequired
The ID of the brand this type is linked to
offline_paymentsbooleanrequired
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_emailbooleanrequired
Whether to disable sending the confirmation email when a membership is confirmed.
privatebooleanrequiredDeprecated
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.
visibilitystringoptional
The visibility of the MembershipType on the site's shop frontend.
Possible values:publicprivatelink_only
minimum_start_datedate-timerequirednullable
The minimum start date for a membership of this type.
min_membersintegerrequired
The minimum number of members required to create a membership of this type
max_membersintegerrequired
The maximum number of members allowed to create a membership of this type
ratesobject[]required
The public MembershipRates for this type, or if a MembershipSignupToken was passed, the rate linked to that.
revenue_schedulestringrequirednullable
The schedule that revenues for this membership should be created, as an RRULE string
created_atdate-timerequired
The datetime which the membership type was created
updated_atdate-timerequired
The datetime which the membership type was last updated
deleted_atdate-timerequirednullable
The datetime which the membership type was archived, or null if it isn't archived.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Gold tier",
  "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
  "terms": "string",
  "brand_id": "00000000-0000-0000-0000-000000000000",
  "offline_payments": false,
  "disable_confirmation_email": false,
  "private": false,
  "visibility": "public",
  "minimum_start_date": "2026-01-15T09:30:00+00:00",
  "min_members": 2,
  "max_members": 4,
  "rates": [
    "string"
  ],
  "revenue_schedule": "FREQ=WEEKLY",
  "created_at": "2026-01-15T09:30:00+00:00",
  "updated_at": "2026-01-15T09:30:00+00:00",
  "deleted_at": "2026-01-15T09:30:00+00:00"
}

get/customers/sites/{siteId}/membership-types

List the membership types for a site

listSiteMembershipTypes

This endpoint retrieves all the membership types associated with a site.

Path parameters

siteIduuidrequired
The site ID

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The membership types for the site were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The membership types for the site were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "string",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "offline_payments": false,
      "disable_confirmation_email": false,
      "private": false,
      "visibility": "public",
      "minimum_start_date": "2026-01-15T09:30:00+00:00",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "membership_type_id": "00000000-0000-0000-0000-000000000000",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [
            "string"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "2026-01-15T09:30:00+00:00",
          "updated_at": "2026-01-15T09:30:00+00:00"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "2026-01-15T09:30:00+00:00",
      "updated_at": "2026-01-15T09:30:00+00:00",
      "deleted_at": "2026-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/customers/sites/{siteId}/membership-types

Enable a membership type for a site

createSiteMembershipType

This endpoint enables a membership type for a site.

Path parameters

siteIduuidrequired
The site ID

Request body

membership_type_iduuidrequired
Identifier of the brand-level membership tier to enable at this site. After enablement, customers can purchase this tier from the site's storefront and existing members of the tier can use it at this site.
site_iduuidrequired
Identifier of the site the membership tier should be enabled at. Must match the siteId in the URL; provided in the body to make the request self-describing for audit logs.

Responses

201
The MembershipType was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "membership_type_id": "00000000-0000-0000-0000-000000000000",
  "site_id": "00000000-0000-0000-0000-000000000000"
}'

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "membership_type_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "site_id": "00000000-0000-0000-0000-000000000000"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'membership_type_id' => '00000000-0000-0000-0000-000000000000',
            'site_id' => '00000000-0000-0000-0000-000000000000'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"membership_type_id": "00000000-0000-0000-0000-000000000000",
		"site_id": "00000000-0000-0000-0000-000000000000",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/sites/{siteId}/membership-types/{membershipTypeId}

Disable a membership type for a site

deleteSiteMembershipType

This endpoint disables a membership type for a site.

Path parameters

siteIduuidrequired
The site ID
membershipTypeIduuidrequired
The ID of the membership type

Responses

204
The membership type was successfully disabled
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The membership type was successfully disabled

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/customers/sites/{siteId}/membership-types/{membershipTypeId}

Check whether a membership type is enabled for a site

listSingleSiteMembershipType

This endpoint checks for the existence of a site membership type for a given membership type.

Path parameters

siteIduuidrequired
The site ID
membershipTypeIduuidrequired
The ID of the membership type

Responses

200
The MembershipType was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/membership-types/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/customers/membership-types

Create MembershipType

createMembershipType

Use this endpoint to create a new MembershipType.

Request body

brand_iduuidrequired
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.
namestringrequired
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.
descriptionstringoptionalnullable
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.
termsstringoptionalnullable
Terms and conditions of the membership type
privatebooleanoptionalDeprecated
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.
visibilitystringoptional
The visibility of the MembershipType on the site's shop frontend.
Possible values:publicprivatelink_only
offline_paymentsbooleanoptional
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_emailbooleanoptional
Whether to disable sending the confirmation email when a membership is confirmed.
minimum_start_datedate-timeoptionalnullable
The minimum start date for a membership of this type.
min_membersintegeroptional
The minimum number of members required to create a membership of this type
max_membersintegeroptional
The maximum number of members allowed to create a membership of this type
revenue_schedulestringoptional
The revenue schedule for the membership type.
Possible values:FREQ=DAILYFREQ=WEEKLYFREQ=MONTHLY;BYMONTHDAY=1
initial_rateobjectrequired
The initial rate to create for the membership type.

Responses

201
The MembershipType was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/membership-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "brand_id": "00000000-0000-0000-0000-000000000000",
  "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",
  "private": false,
  "visibility": "public",
  "offline_payments": false,
  "disable_confirmation_email": false,
  "minimum_start_date": "2026-01-15T09:30:00+00:00",
  "min_members": 2,
  "max_members": 4,
  "revenue_schedule": "FREQ=DAILY",
  "initial_rate": {
    "processors": [
      "stripe"
    ],
    "amount": 1000,
    "currency": "GBP",
    "billing_frequency": "P1M",
    "default_duration": "P1M"
  }
}'

const response = await fetch('https://api.playground.try.be/customers/membership-types', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "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",
    "private": false,
    "visibility": "public",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "revenue_schedule": "FREQ=DAILY",
    "initial_rate": {
      "processors": [
        "stripe"
      ],
      "amount": 1000,
      "currency": "GBP",
      "billing_frequency": "P1M",
      "default_duration": "P1M"
    }
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/membership-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "brand_id": "00000000-0000-0000-0000-000000000000",
        "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",
        "private": False,
        "visibility": "public",
        "offline_payments": False,
        "disable_confirmation_email": False,
        "minimum_start_date": "2026-01-15T09:30:00+00:00",
        "min_members": 2,
        "max_members": 4,
        "revenue_schedule": "FREQ=DAILY",
        "initial_rate": {
            "processors": [
                "stripe"
            ],
            "amount": 1000,
            "currency": "GBP",
            "billing_frequency": "P1M",
            "default_duration": "P1M"
        }
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/membership-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'brand_id' => '00000000-0000-0000-0000-000000000000',
            '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
period for cancellation. See https://example.com/terms for the
full agreement.
',
            'private' => false,
            'visibility' => 'public',
            'offline_payments' => false,
            'disable_confirmation_email' => false,
            'minimum_start_date' => '2026-01-15T09:30:00+00:00',
            'min_members' => 2,
            'max_members' => 4,
            'revenue_schedule' => 'FREQ=DAILY',
            'initial_rate' => [
                'processors' => [
                    'stripe'
                ],
                'amount' => 1000,
                'currency' => 'GBP',
                'billing_frequency' => 'P1M',
                'default_duration' => 'P1M'
            ]
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"brand_id": "00000000-0000-0000-0000-000000000000",
		"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",
		"private": false,
		"visibility": "public",
		"offline_payments": false,
		"disable_confirmation_email": false,
		"minimum_start_date": "2026-01-15T09:30:00+00:00",
		"min_members": 2,
		"max_members": 4,
		"revenue_schedule": "FREQ=DAILY",
		"initial_rate": map[string]interface{}{
			"processors": []interface{}{
				"stripe",
			},
			"amount": 1000,
			"currency": "GBP",
			"billing_frequency": "P1M",
			"default_duration": "P1M",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/membership-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/customers/membership-types/{membershipTypeId}

Show MembershipType

getMembershipType

This endpoint retrieves a MembershipType by its ID.

Path parameters

membershipTypeIduuidrequired
The ID of the MembershipType.

Responses

200
The MembershipType was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/customers/membership-types/{membershipTypeId}

Update MembershipType

updateMembershipType

Use this endpoint to update a MembershipType.

Path parameters

membershipTypeIduuidrequired
The ID of the MembershipType.

Request body

namestringoptional
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.
descriptionstringoptionalnullable
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.
termsstringoptionalnullable
Terms and conditions of the membership type
privatebooleanoptionalDeprecated
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.
visibilitystringoptional
The visibility of the MembershipType on the site's shop frontend.
Possible values:publicprivatelink_only
offline_paymentsbooleanoptional
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_emailbooleanoptional
Whether to disable sending the confirmation email when a membership is confirmed.
minimum_start_datedate-timeoptionalnullable
The minimum start date for a membership of this type.
min_membersintegeroptional
The minimum number of members required to create a membership of this type
max_membersintegeroptional
The maximum number of members allowed to create a membership of this type
revenue_schedulestringoptional
The revenue schedule for the membership type.
Possible values:FREQ=DAILYFREQ=WEEKLYFREQ=MONTHLY;BYMONTHDAY=1

Responses

200
The MembershipType was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "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",
  "private": false,
  "visibility": "public",
  "offline_payments": false,
  "disable_confirmation_email": false,
  "minimum_start_date": "2026-01-15T09:30:00+00:00",
  "min_members": 2,
  "max_members": 4,
  "revenue_schedule": "FREQ=DAILY"
}'

const response = await fetch('https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "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",
    "private": false,
    "visibility": "public",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "revenue_schedule": "FREQ=DAILY"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "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",
        "private": False,
        "visibility": "public",
        "offline_payments": False,
        "disable_confirmation_email": False,
        "minimum_start_date": "2026-01-15T09:30:00+00:00",
        "min_members": 2,
        "max_members": 4,
        "revenue_schedule": "FREQ=DAILY"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            '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
period for cancellation. See https://example.com/terms for the
full agreement.
',
            'private' => false,
            'visibility' => 'public',
            'offline_payments' => false,
            'disable_confirmation_email' => false,
            'minimum_start_date' => '2026-01-15T09:30:00+00:00',
            'min_members' => 2,
            'max_members' => 4,
            'revenue_schedule' => 'FREQ=DAILY'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"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",
		"private": false,
		"visibility": "public",
		"offline_payments": false,
		"disable_confirmation_email": false,
		"minimum_start_date": "2026-01-15T09:30:00+00:00",
		"min_members": 2,
		"max_members": 4,
		"revenue_schedule": "FREQ=DAILY",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/membership-types/{membershipTypeId}

Soft-deletes the given MembershipType. Existing memberships that reference this type are unaffected, but the type can no longer be selected for new memberships. Use the companion restoreMembershipType endpoint to undo.

Path parameters

membershipTypeIduuidrequired
The ID of the MembershipType.

Responses

204
The MembershipType was successfully soft-deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully soft-deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/customers/membership-types/{membershipTypeId}/copy

Copy a MembershipType

actionCopyMembershipType

This endpoint copies an existing MembershipType by ID.

Path parameters

membershipTypeIduuidrequired
The ID of the MembershipType.

Request body

namestringrequired
Display name to give the duplicated membership tier. The new tier inherits the source tier's pricing, visibility, and benefits; the name distinguishes the copy from the original. 1-120 characters.

Responses

200
The MembershipType was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Gold tier"
}'

const response = await fetch('https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Gold tier"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Gold tier"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Gold tier'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Gold tier",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/customers/membership-types/{membershipTypeId}/restore

Restore a MembershipType

restoreMembershipType

Restores a soft-deleted MembershipType so it can once again be selected for new memberships. Partner to deleteMembershipType.

Path parameters

membershipTypeIduuidrequired
The ID of the MembershipType.

Responses

200
The MembershipType was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/restore', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/restore', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/membership-types/00000000-0000-0000-0000-000000000000/restore", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier",
    "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
    "terms": "string",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "offline_payments": false,
    "disable_confirmation_email": false,
    "private": false,
    "visibility": "public",
    "minimum_start_date": "2026-01-15T09:30:00+00:00",
    "min_members": 2,
    "max_members": 4,
    "rates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "revenue_schedule": "FREQ=WEEKLY",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/customers/ordered-membership-types

List MembershipTypes in display order

listOrderedMembershipTypes

Returns a lightweight { id, name } summary of every MembershipType in the caller's organisation, sorted by the organisation-wide display order (the order column on the type), then by creation time as a tiebreak.

Use this to power UIs that need to render the type list in the operator-chosen order — typically the drag-to-reorder admin screen or any storefront component that picks the "first" type to feature. For the full MembershipType payload (with rates and metadata), use listMembershipTypes instead.

Query parameters

organisation_iduuidoptional
Filter customers that belong to the given organisation ID

Responses

200
The MembershipTypes were retrieved in display order.
401
The user is unauthenticated

curl "https://api.playground.try.be/customers/ordered-membership-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/ordered-membership-types', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/ordered-membership-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/ordered-membership-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/ordered-membership-types", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType`s were retrieved in display order.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier"
    }
  ]
}

{
  "message": "Unauthenticated"
}

put/customers/ordered-membership-types

Reorder MembershipTypes

updateMembershipTypeOrder

Persists a new display order for the caller's MembershipTypes by writing the supplied IDs back to each type's order column in the order they appear in the array. The first ID becomes order 0, the second 1, and so on.

The array must contain only IDs the caller is authorised to manage; IDs missing from the array keep their current order value (i.e. the caller can reorder a subset without listing every type). Returns the updated ordered list, matching listOrderedMembershipTypes.

Request body

membership_type_idsstring[]required
The MembershipType IDs in the new display order. The first ID becomes order 0, the second 1, and so on. IDs not included in this array retain their existing order value.

Responses

200
The MembershipTypes were retrieved in display order.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/ordered-membership-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "membership_type_ids": [
    "9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d",
    "1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
  ]
}'

const response = await fetch('https://api.playground.try.be/customers/ordered-membership-types', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "membership_type_ids": [
      "9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d",
      "1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
    ]
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/ordered-membership-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "membership_type_ids": [
            "9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d",
            "1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/ordered-membership-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'membership_type_ids' => [
                '9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d',
                '1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e'
            ]
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"membership_type_ids": []interface{}{
			"9c4d6c4e-3a5a-4f6e-9d6b-1f7e8a9c0b1d",
			"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/ordered-membership-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `MembershipType`s were retrieved in display order.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}