Memberships

A Membership represents a membership belonging to one or more Customers.

The Membership object

Attributes

iduuidrequired
The ID of the membership
attention_reasonstringrequired
A string describing what kind of action needs to take place
Possible values:no_mandatesetup_unpaidmandate_revokedpayment_failedpayment_disputedpayment_outstandingsite_id
basket_idmongo-idrequired
The basket ID which was used to purchase this membership, if applicable.
customerobjectoptional
end_datedate-timerequirednullable
The date which the membership ends
external_refstringrequired
An external reference for this membership.
membersobject[]required
membership_numberstringrequiredDeprecated
The unique membership number of the lead member. This is always a 10 digit numeric string. Since this field only relates to the lead member, this is now deprecated. Instead, find the membership for the relevant customer in the members array.
next_billing_datedate-timerequirednullable
The date which the membership will next be billed
next_chargeobjectoptionalnullable
A summary of the next charge that's due for this membership.

This property is only populated when the membership was retrieved using the `getCustomerMemberships endpoint.
payment_methodobjectrequirednullable
Details about the payment method attached to this membership. This payment method is used to take payment on the monthly billing period. If a payment method hasn't been set up, this will be null.
rateobjectrequired
site_iduuidrequired
The ID of the site this membership belongs to
sourcestringrequired
Where the membership was created
Possible values:self_signupappimportunknown
start_datedate-timerequired
The date which the membership starts
statusstringrequired
Possible values:activeneeds_dd_mandateneeds_attentionreservedinactiveexpiredupcoming
status_updated_atdate-timerequired
typeobjectrequired
payment_details_urlstringoptional
A URL to a page where the member can provide their payment details.
created_atdate-timerequired
The datetime which the membership was created

{
  "id": "00000000-0000-0000-0000-000000000000",
  "attention_reason": "no_mandate",
  "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "customer": {},
  "end_date": "2026-01-15T09:30:00+00:00",
  "external_ref": "EXT-12345",
  "members": [
    {
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "is_lead": true,
      "membership_number": "1234567890"
    }
  ],
  "membership_number": "1234567890",
  "next_billing_date": "2026-01-15T09:30:00+00:00",
  "next_charge": {
    "id": "00000000-0000-0000-0000-000000000000",
    "amount": 3995,
    "currency": "GBP",
    "status": "awaiting_approval",
    "billing_period_from": "2026-01-15",
    "billing_period_to": "2026-01-15"
  },
  "payment_method": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "card",
    "last_4": "string",
    "status": "revoked",
    "card_brand": "amex"
  },
  "rate": {},
  "site_id": "00000000-0000-0000-0000-000000000000",
  "source": "self_signup",
  "start_date": "2026-01-15T09:30:00+00:00",
  "status": "active",
  "status_updated_at": "2026-01-15T09:30:00+00:00",
  "type": {},
  "payment_details_url": "https://example.com",
  "created_at": "2026-01-15T09:30:00+00:00"
}

get/customers/memberships

Use this endpoint to create a new Membership. A Membership always requires a Customer, but for convenience, you can pass customer_data to create the customer inline and attach the membership to the newly created customer.

Unless you're authorised to do so, you'll only be permitted to create a membership for a private MembershipType and/or a non-default MembershipRate when you provide a valid MembershipSignupToken ID for the type and rate in question.

The status of newly created memberships is always reserved. You'll need to make a request to the confirmMembership endpoint to update the status once the pro-rata or joining fee payment has been paid.

Header parameters

X-Trybe-On-Behalf-Ofuuidoptional
The user ID of the user the request is made on behalf of.

Request body

customer_idstringoptional
The Customer the new membership should be attached to. Mutually exclusive with customer_data: pass exactly one of customer_id (link to an existing customer) or customer_data (create a customer inline). The customer must belong to the same brand as the supplied membership_type_id.
site_idstringoptional
The site ID which this membership belongs to
customer_dataobjectoptional
Inline customer data to create a new customer with the membership. See createCustomer for the full list of accepted fields.
membership_type_idstringrequired
The membership type ID. This must belong to the same brand as the given customer.
membership_rate_idstringrequired
The membership rate ID. This must belong to the same type as provided.
intake_form_requiredbooleanoptional
Whether an intake form is required for this membership
basket_idstringoptional
The basket ID which was used to purchase this membership, if applicable.
sourcestringoptional
The source of where this membership was created.
Possible values:appself_signup
external_refstringoptional
Free-form identifier for cross-referencing this membership with an external system (e.g. a legacy CRM record number). Returned verbatim on getMembership and not interpreted by the platform.
start_datedaterequired
The date which the membership should start from.
end_datedaterequirednullable
The date which the membership should end.

Responses

201
The Membership 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/memberships" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "X-Trybe-On-Behalf-Of: 00000000-0000-0000-0000-000000000000" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "site_id": "000000-000000-000000-000000",
  "customer_data": {},
  "membership_type_id": "000000-000000-000000-000000",
  "membership_rate_id": "000000-000000-000000-000000",
  "intake_form_required": true,
  "basket_id": "60c0c01d92ec44e252235966",
  "source": "app",
  "external_ref": "legacy-crm-7421",
  "start_date": "2021-01-01",
  "end_date": "2022-01-01"
}'

const response = await fetch('https://api.playground.try.be/customers/memberships', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
    'X-Trybe-On-Behalf-Of': '00000000-0000-0000-0000-000000000000',
  },
  body: JSON.stringify({
    "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "site_id": "000000-000000-000000-000000",
    "customer_data": {},
    "membership_type_id": "000000-000000-000000-000000",
    "membership_rate_id": "000000-000000-000000-000000",
    "intake_form_required": true,
    "basket_id": "60c0c01d92ec44e252235966",
    "source": "app",
    "external_ref": "legacy-crm-7421",
    "start_date": "2021-01-01",
    "end_date": "2022-01-01"
  }),
})

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/memberships",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
        "X-Trybe-On-Behalf-Of": "00000000-0000-0000-0000-000000000000",
    },
    json={
        "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "site_id": "000000-000000-000000-000000",
        "customer_data": {

        },
        "membership_type_id": "000000-000000-000000-000000",
        "membership_rate_id": "000000-000000-000000-000000",
        "intake_form_required": True,
        "basket_id": "60c0c01d92ec44e252235966",
        "source": "app",
        "external_ref": "legacy-crm-7421",
        "start_date": "2021-01-01",
        "end_date": "2022-01-01"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/memberships', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
        'X-Trybe-On-Behalf-Of' => '00000000-0000-0000-0000-000000000000',
    ],
    'json' => [
            'customer_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'site_id' => '000000-000000-000000-000000',
            'customer_data' => [

            ],
            'membership_type_id' => '000000-000000-000000-000000',
            'membership_rate_id' => '000000-000000-000000-000000',
            'intake_form_required' => true,
            'basket_id' => '60c0c01d92ec44e252235966',
            'source' => 'app',
            'external_ref' => 'legacy-crm-7421',
            'start_date' => '2021-01-01',
            'end_date' => '2022-01-01'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"site_id": "000000-000000-000000-000000",
		"customer_data": map[string]interface{}{

		},
		"membership_type_id": "000000-000000-000000-000000",
		"membership_rate_id": "000000-000000-000000-000000",
		"intake_form_required": true,
		"basket_id": "60c0c01d92ec44e252235966",
		"source": "app",
		"external_ref": "legacy-crm-7421",
		"start_date": "2021-01-01",
		"end_date": "2022-01-01",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/memberships", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-Trybe-On-Behalf-Of", "00000000-0000-0000-0000-000000000000")
	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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_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/memberships/{membershipId}

Show a membership

getMembership

Use this endpoint to retrieve a Membership by its ID.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

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

curl "https://api.playground.try.be/customers/memberships/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/memberships/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/memberships/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/memberships/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/memberships/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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

put/customers/memberships/{membershipId}

Update a Membership

updateMembership

Update mutable fields on an existing Membership such as its membership type, rate, start/end dates and external reference.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

membership_type_idstringoptional
The membership type ID. This must belong to the same brand as the given customer.
membership_rate_idstringoptional
The membership rate ID. This must belong to the same type as provided.
start_datedateoptional
The date which the membership should start from.
end_datedateoptionalnullable
The date which the membership should end.
external_refstringoptional
Free-form identifier for cross-referencing this membership with an external system (e.g. a legacy CRM record number). Returned verbatim on getMembership and not interpreted by the platform.

Responses

200
The Membership 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/memberships/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "membership_type_id": "000000-000000-000000-000000",
  "membership_rate_id": "000000-000000-000000-000000",
  "start_date": "2021-01-01",
  "end_date": "2022-01-01",
  "external_ref": "legacy-crm-7421"
}'

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "membership_type_id": "000000-000000-000000-000000",
    "membership_rate_id": "000000-000000-000000-000000",
    "start_date": "2021-01-01",
    "end_date": "2022-01-01",
    "external_ref": "legacy-crm-7421"
  }),
})

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/memberships/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "membership_type_id": "000000-000000-000000-000000",
        "membership_rate_id": "000000-000000-000000-000000",
        "start_date": "2021-01-01",
        "end_date": "2022-01-01",
        "external_ref": "legacy-crm-7421"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'membership_type_id' => '000000-000000-000000-000000',
            'membership_rate_id' => '000000-000000-000000-000000',
            'start_date' => '2021-01-01',
            'end_date' => '2022-01-01',
            'external_ref' => 'legacy-crm-7421'
        ],
]);

$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": "000000-000000-000000-000000",
		"membership_rate_id": "000000-000000-000000-000000",
		"start_date": "2021-01-01",
		"end_date": "2022-01-01",
		"external_ref": "legacy-crm-7421",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/memberships/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 `Membership` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_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/memberships/{membershipId}

Archive a Membership

deleteMembership

Archives a Membership. Archived memberships are removed from the active list but their record is retained for reporting purposes.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

204
The membership was successfully archived.
400
The request failed.
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/memberships/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/memberships/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/memberships/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/memberships/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/memberships/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 was successfully archived.

// empty response

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

post/shop/membership-charges/{chargeId}/payment

Record a manual payment against a charge

actionAddMembershipChargePayment

This endpoint allows a manual (off-Trybe) payment to be recorded against a membership charge.

Path parameters

chargeIduuidrequired
The ID of the charge

Request body

payment_type_idobject-idrequired
Identifier of the custom payment type to attribute this membership charge to (e.g. "BACS", "Cash on file"). Lets you record an offline-collected payment against a membership charge for accurate reporting. The payment type must belong to the same site as the membership.
amountintegeroptionalnullable
The amount of the payment

Responses

200
A charge against a membership.
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/shop/membership-charges/00000000-0000-0000-0000-000000000000/payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "payment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "amount": 1000
}'

const response = await fetch('https://api.playground.try.be/shop/membership-charges/00000000-0000-0000-0000-000000000000/payment', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "payment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "amount": 1000
  }),
})

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/shop/membership-charges/00000000-0000-0000-0000-000000000000/payment",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "payment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "amount": 1000
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/membership-charges/00000000-0000-0000-0000-000000000000/payment', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'payment_type_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'amount' => 1000
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"payment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"amount": 1000,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/membership-charges/00000000-0000-0000-0000-000000000000/payment", 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)
}

A charge against a membership.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership": {
      "id": "00000000-0000-0000-0000-000000000000",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "Free-form text from the resource.",
    "can_download_receipt": false,
    "amount_refunded": 1,
    "refunded": false,
    "refunds": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "00000000-0000-0000-0000-000000000000",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "site_id": "00000000-0000-0000-0000-000000000000",
    "billing_period_from": "2026-01-15",
    "billing_period_to": "2026-01-15",
    "processing_at": "2026-01-15T09:30:00+00:00",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_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/shop/membership-charges/{chargeId}/process

Manually process a charge for a membership

actionProcessMembershipCharge

This endpoint allows a membership charge to be processed manually.

Path parameters

chargeIduuidrequired
The ID of the charge

Responses

200
A charge against a membership.
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/shop/membership-charges/00000000-0000-0000-0000-000000000000/process" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/membership-charges/00000000-0000-0000-0000-000000000000/process', {
  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/shop/membership-charges/00000000-0000-0000-0000-000000000000/process",
    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/shop/membership-charges/00000000-0000-0000-0000-000000000000/process', [
    '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/shop/membership-charges/00000000-0000-0000-0000-000000000000/process", 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)
}

A charge against a membership.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership": {
      "id": "00000000-0000-0000-0000-000000000000",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "Free-form text from the resource.",
    "can_download_receipt": false,
    "amount_refunded": 1,
    "refunded": false,
    "refunds": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "00000000-0000-0000-0000-000000000000",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "site_id": "00000000-0000-0000-0000-000000000000",
    "billing_period_from": "2026-01-15",
    "billing_period_to": "2026-01-15",
    "processing_at": "2026-01-15T09:30:00+00:00",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

post/shop/membership-charges/{chargeId}/retry

Manually retry a charge for a membership

actionRetryMembershipCharge

This endpoint allows a membership charge to be retried manually.

Path parameters

chargeIduuidrequired
The ID of the charge

Responses

200
A charge against a membership.
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/shop/membership-charges/00000000-0000-0000-0000-000000000000/retry" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/membership-charges/00000000-0000-0000-0000-000000000000/retry', {
  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/shop/membership-charges/00000000-0000-0000-0000-000000000000/retry",
    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/shop/membership-charges/00000000-0000-0000-0000-000000000000/retry', [
    '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/shop/membership-charges/00000000-0000-0000-0000-000000000000/retry", 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)
}

A charge against a membership.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership": {
      "id": "00000000-0000-0000-0000-000000000000",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "Free-form text from the resource.",
    "can_download_receipt": false,
    "amount_refunded": 1,
    "refunded": false,
    "refunds": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "00000000-0000-0000-0000-000000000000",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      }
    ],
    "site_id": "00000000-0000-0000-0000-000000000000",
    "billing_period_from": "2026-01-15",
    "billing_period_to": "2026-01-15",
    "processing_at": "2026-01-15T09:30:00+00:00",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

post/shop/memberships/{membershipId}/sms

Send an SMS message for a membership

createMembershipSms

This endpoint sends an SMS message to a membership's lead member. Currently supports sending billing details request messages.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

message_typestringrequired
The type of message to send.
Possible values:billing_details_request
always_sendbooleanoptional
If true, send the SMS even if the membership already has a payment method. Defaults to false.

Responses

200
The SMS message was successfully sent
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/shop/memberships/00000000-0000-0000-0000-000000000000/sms" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "message_type": "billing_details_request",
  "always_send": false
}'

const response = await fetch('https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "message_type": "billing_details_request",
    "always_send": false
  }),
})

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/shop/memberships/00000000-0000-0000-0000-000000000000/sms",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "message_type": "billing_details_request",
        "always_send": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'message_type' => 'billing_details_request',
            'always_send' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"message_type": "billing_details_request",
		"always_send": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms", 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 SMS message was successfully sent

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "membership_id": "00000000-0000-0000-0000-000000000000",
    "from": "Trybe",
    "to": "+447123456789",
    "message": "string",
    "message_type": "billing_details_request",
    "message_delivered": true,
    "created_at": "2024-02-02T12:00:00Z",
    "sent_at": "2024-02-02T12:00:00Z"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

post/shop/memberships/{membershipId}/sms/preview

Preview an SMS message for a membership

createMembershipSmsPreview

This endpoint previews an SMS message for a membership.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

message_typestringrequired
The type of the SMS message.
Possible values:billing_details_request
always_sendbooleanoptional
If true, preview the SMS even if the membership already has a payment method. Defaults to false.

Responses

200
The preview of the SMS message 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/shop/memberships/00000000-0000-0000-0000-000000000000/sms/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "message_type": "billing_details_request",
  "always_send": false
}'

const response = await fetch('https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms/preview', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "message_type": "billing_details_request",
    "always_send": false
  }),
})

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/shop/memberships/00000000-0000-0000-0000-000000000000/sms/preview",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "message_type": "billing_details_request",
        "always_send": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms/preview', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'message_type' => 'billing_details_request',
            'always_send' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"message_type": "billing_details_request",
		"always_send": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/memberships/00000000-0000-0000-0000-000000000000/sms/preview", 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 preview of the SMS message was successfully retrieved

{
  "data": {
    "message": "Your Premium Membership membership is almost ready! Please provide payment details for your membership payments. Set up here: https://example.com/confirm\n",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000"
  }
}

{
  "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/memberships/{membershipId}/add-payment

Add a manual payment

actionAddManualPayment

Records a manual payment against the membership. Use this when a payment for the membership has been collected outside of Trybe (e.g. cash or bank transfer) and you want to mark the current billing period as paid.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

processor_type_idstringrequired
The custom payment-processor type to attribute this manual payment to (e.g. a cash, bank-transfer or gift-card processor configured on the site). The platform uses this to group the payment in revenue reports without going through a real card processor.

Responses

200
The Membership was successfully retrieved
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/add-payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "processor_type_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d"
}'

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/add-payment', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "processor_type_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d"
  }),
})

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/memberships/00000000-0000-0000-0000-000000000000/add-payment",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "processor_type_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/add-payment', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'processor_type_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"processor_type_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/add-payment", 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 `Membership` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "string"
}

{
  "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/memberships/{membershipId}/cancel

Cancel a membership

actionCancelMembership

Cancels the given Membership. Cancelling a membership marks it as no longer active and stops further billing.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The Membership 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/memberships/00000000-0000-0000-0000-000000000000/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/cancel', {
  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/memberships/00000000-0000-0000-0000-000000000000/cancel",
    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/memberships/00000000-0000-0000-0000-000000000000/cancel', [
    '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/memberships/00000000-0000-0000-0000-000000000000/cancel", 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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/checkout-session/direct-debit

Collect Direct Debit details

createDirectDebitCheckoutSession

This endpoint is used to create the Stripe Checkout session for collecting bank details for a Direct Debit mandate. A stripe_session_id is returned which can be passed into the Stripe.js SDK to redirect the user to the checkout.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The Stripe Checkout session was successfully created.
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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/direct-debit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/checkout-session/direct-debit', {
  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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/direct-debit",
    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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/direct-debit', [
    '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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/direct-debit", 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 Stripe Checkout session was successfully created.

{
  "status": "needs_dd_mandate",
  "account_id": "acct_1Jmwv72UMaxwwwup",
  "url": "https://example.com",
  "stripe_session_id": "si_1234567890",
  "rate_price": {
    "amount": 1000,
    "currency": "GBP"
  },
  "rate_frequency": "P1M"
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/checkout-session/joining-fee

Collect a joining fee

createJoiningFeeCheckoutSession

This endpoint is used to create the Stripe Checkout session for collecting a joining fee as well as any pro-rata fees. A stripe_session_id is returned which can be passed into the Stripe.js SDK to redirect the user to the checkout.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The Stripe Checkout session was successfully created.
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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/joining-fee" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/checkout-session/joining-fee', {
  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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/joining-fee",
    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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/joining-fee', [
    '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/memberships/00000000-0000-0000-0000-000000000000/checkout-session/joining-fee", 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 Stripe Checkout session was successfully created.

{
  "status": "needs_dd_mandate",
  "account_id": "acct_1Jmwv72UMaxwwwup",
  "url": "https://example.com",
  "stripe_session_id": "si_1234567890",
  "rate_price": {
    "amount": 1000,
    "currency": "GBP"
  },
  "rate_frequency": "P1M"
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/confirm

Confirm a membership

actionConfirmMembership

When a membership is created through the self-signup flow, it first goes into the "reserved" stage. This means the client hasn't completed their signup yet, and the basket needs to be completed. Calling this endpoint sets the status to needs_attention if a mandate is required, or active if not.

Path parameters

membershipIduuidrequired
The ID of the membership

Header parameters

X-Trybe-On-Behalf-Ofuuidoptional
The user ID of the user the request is made on behalf of.

Responses

200
The Membership was successfully retrieved
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/confirm" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "X-Trybe-On-Behalf-Of: 00000000-0000-0000-0000-000000000000"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/confirm', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
    'X-Trybe-On-Behalf-Of': '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/memberships/00000000-0000-0000-0000-000000000000/confirm",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "X-Trybe-On-Behalf-Of": "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/memberships/00000000-0000-0000-0000-000000000000/confirm', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'X-Trybe-On-Behalf-Of' => '00000000-0000-0000-0000-000000000000',
    ],
]);

$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/memberships/00000000-0000-0000-0000-000000000000/confirm", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("X-Trybe-On-Behalf-Of", "00000000-0000-0000-0000-000000000000")
	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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/issue-credits

Issue credits for a membership

actionIssueMembershipCredits

Queues a job that issues credits to the members of the given membership, according to the membership's credit rules. Credits are issued asynchronously.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

204
The request to issue credits was successful and is being processed.
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/memberships/00000000-0000-0000-0000-000000000000/issue-credits" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/issue-credits', {
  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/memberships/00000000-0000-0000-0000-000000000000/issue-credits",
    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/memberships/00000000-0000-0000-0000-000000000000/issue-credits', [
    '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/memberships/00000000-0000-0000-0000-000000000000/issue-credits", 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 request to issue credits was successful and is being processed.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/customers/memberships/{membershipId}/members

Retrieve a list of members for a membership

listMembershipMembers

Returns the list of MembershipMembers on the given membership, including their customer record, membership number and lead-member status.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The list of MembershipMembers for the given membership was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/members', {
  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/memberships/00000000-0000-0000-0000-000000000000/members",
    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/memberships/00000000-0000-0000-0000-000000000000/members', [
    '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/memberships/00000000-0000-0000-0000-000000000000/members", 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 list of `MembershipMember`s for the given membership was successfully retrieved.

{
  "data": [
    {
      "membership_number": "string",
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "2026-01-15",
        "brand_id": "00000000-0000-0000-0000-000000000000",
        "site_id": "00000000-0000-0000-0000-000000000000",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "2026-01-15T09:30:00+00:00",
        "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",
        "last_active_at": "2026-01-15T09:30:00+00:00",
        "email_verified_at": "2026-01-15T09:30:00+00:00",
        "last_check_in": {
          "checked_in_at": "2026-01-15T09:30:00+00:00",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "ext-cust-789012"
      },
      "is_lead": true
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

{
  "message": "Unauthenticated"
}

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

post/customers/memberships/{membershipId}/members

Add a member to a membership

createMembershipMember

Adds an existing Customer to the given Membership as an additional member. The customer is identified by their customer_id.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

customer_iduuidrequired
The Customer to add as a member of the membership. The customer must belong to the same brand as the membership; the platform rejects cross-brand additions with 422 Unprocessable Entity.

Responses

200
The MembershipMember was successfully retrieved or updated.
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/members" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "00000000-0000-0000-0000-000000000000"
}'

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/members', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "customer_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/memberships/00000000-0000-0000-0000-000000000000/members",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "customer_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/memberships/00000000-0000-0000-0000-000000000000/members', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'customer_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{}{
		"customer_id": "00000000-0000-0000-0000-000000000000",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/members", 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 `MembershipMember` was successfully retrieved or updated.

{
  "data": {
    "membership_number": "string",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "is_lead": true
  }
}

{
  "message": "string"
}

{
  "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/memberships/{membershipId}/members/{customerId}

Remove a member from a membership

deleteMembershipMember

Removes the given customer from the given Membership. The customer's record is preserved; only the link between the customer and the membership is removed.

Path parameters

membershipIduuidrequired
The ID of the membership
customerIduuidrequired
The ID of the customer to act on within the membership

Responses

204
The member was successfully removed from the membership.
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/members/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/memberships/00000000-0000-0000-0000-000000000000/members/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/memberships/00000000-0000-0000-0000-000000000000/members/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/memberships/00000000-0000-0000-0000-000000000000/members/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/memberships/00000000-0000-0000-0000-000000000000/members/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 member was successfully removed from the membership.

// empty response

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

get/customers/memberships/{membershipId}/next-billing-details

Get the next billing details for a membership

getNextBillingDetails

Returns the next billing date and amount for the given Membership. If the membership will not be active on the next billing date, the date and amount will be null.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The next billing details for the membership were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/next-billing-details" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/next-billing-details', {
  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/memberships/00000000-0000-0000-0000-000000000000/next-billing-details",
    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/memberships/00000000-0000-0000-0000-000000000000/next-billing-details', [
    '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/memberships/00000000-0000-0000-0000-000000000000/next-billing-details", 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 next billing details for the membership were successfully retrieved.

{
  "data": {
    "date": "2026-01-15",
    "amount": 1,
    "currency": "GBP"
  }
}

{
  "message": "Unauthenticated"
}

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

post/customers/memberships/{membershipId}/regenerate-charges

Regenerate pending charges for a membership

actionRegenerateMembershipCharges

Regenerates pending charges for the given Membership. Any pending charges are discarded and new ones are created based on the current rate and billing schedule.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

204
The request to regenerate charges was successful and is being processed.
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/memberships/00000000-0000-0000-0000-000000000000/regenerate-charges" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/regenerate-charges', {
  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/memberships/00000000-0000-0000-0000-000000000000/regenerate-charges",
    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/memberships/00000000-0000-0000-0000-000000000000/regenerate-charges', [
    '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/memberships/00000000-0000-0000-0000-000000000000/regenerate-charges", 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 request to regenerate charges was successful and is being processed.

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/request-mandate

Send the mandate request email

actionRequestMandate

Sends the Direct Debit mandate request email to the lead member of the membership. The email contains a link to a Stripe Checkout session for collecting the bank details.

Returns a 400 if the membership doesn't require a mandate - the status must be needs_dd_mandate or needs_attention for this endpoint to send the email.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The Membership was successfully retrieved
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/request-mandate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/request-mandate', {
  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/memberships/00000000-0000-0000-0000-000000000000/request-mandate",
    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/memberships/00000000-0000-0000-0000-000000000000/request-mandate', [
    '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/memberships/00000000-0000-0000-0000-000000000000/request-mandate", 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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/retry-payment

Retry the payment for a membership

actionRetryPayment

Retries the most recent failed payment for the given Membership.

Returns a 400 if the payment couldn't be retried. This can happen if the membership already has a processing payment, or the billing date is in the future, or the membership is not in the needs_attention status with an attention reason of payment_failed.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The Membership was successfully retrieved
400
The request failed.
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/memberships/00000000-0000-0000-0000-000000000000/retry-payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/retry-payment', {
  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/memberships/00000000-0000-0000-0000-000000000000/retry-payment",
    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/memberships/00000000-0000-0000-0000-000000000000/retry-payment', [
    '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/memberships/00000000-0000-0000-0000-000000000000/retry-payment", 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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/send-confirmation-email

Send a confirmation email for a membership

actionSendMembershipConfirmationEmail

Sends (or re-sends) the membership signup confirmation email to the lead member. The email is dispatched asynchronously.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

204
The request to send a confirmation email was successful and is being processed.
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/memberships/00000000-0000-0000-0000-000000000000/send-confirmation-email" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/send-confirmation-email', {
  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/memberships/00000000-0000-0000-0000-000000000000/send-confirmation-email",
    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/memberships/00000000-0000-0000-0000-000000000000/send-confirmation-email', [
    '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/memberships/00000000-0000-0000-0000-000000000000/send-confirmation-email", 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 request to send a confirmation email was successful and is being processed.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/customers/memberships/{membershipId}/subsequent-billing-date

Get the subsequent billing date for a membership

getSubsequentBillingDate

Returns the subsequent billing date for the given Membership - i.e. the billing date after next_billing_date. If the membership will not be active on the subsequent billing date, the date will be null.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The subsequent billing date for the membership was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-date" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-date', {
  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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-date",
    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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-date', [
    '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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-date", 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 subsequent billing date for the membership was successfully retrieved.

{
  "data": "2026-01-15"
}

{
  "message": "Unauthenticated"
}

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

get/customers/memberships/{membershipId}/subsequent-billing-details

Get the subsequent billing details for a membership

getSubsequentBillingDetails

Returns the subsequent billing date and amount for the given Membership - i.e. the billing event after next_billing_date. If the membership will not be active on the subsequent billing date, the date and amount will be null.

Path parameters

membershipIduuidrequired
The ID of the membership

Responses

200
The subsequent billing details for the membership were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-details" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-details', {
  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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-details",
    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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-details', [
    '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/memberships/00000000-0000-0000-0000-000000000000/subsequent-billing-details", 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 subsequent billing details for the membership were successfully retrieved.

{
  "data": {
    "date": "2026-01-15",
    "amount": 1,
    "currency": "GBP"
  }
}

{
  "message": "Unauthenticated"
}

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

get/customers/memberships/queue

Queue a report of memberships

queueListMemberships

Retrieves a report of memberships in CSV format. The report will be generated asynchronously.

Query parameters

customer_iduuidoptional
Filters memberships belonging to the specified customer
site_idstringoptional
The site ID to filter against
statusstring[]optional
The status of the membership
membership_type_iduuidoptionalDeprecated
Deprecated. Use membership_type_ids instead.
membership_type_idsstring[]optional
The membership type IDs to filter against. Separate multiple IDs with a comma.
membership_rate_idsstring[]optional
Restrict the result to memberships on the given membership rates. Pass one or more MembershipRate IDs separated by commas. When omitted, all rates are returned.
created_at_fromdateoptional
Filter memberships created no earlier than the given date
created_at_todateoptional
Filter memberships created no later than the given date
next_billing_date_fromdateoptional
Filter memberships due for billing no earlier than the given date
next_billing_date_todateoptional
Filter memberships due for billing no later than the given date
end_date_fromdateoptional
Filter memberships that end no earlier than the given date
end_date_todateoptional
Filter memberships that end no later than the given date
attention_reasonstringoptional
The reason why this membership needs attention
manual_paymentsbooleanoptional
Whether to only show membership types that have auto-payments disabled
membership_numberstringoptional
The membership number to filter against
external_refstringoptional
The external reference to filter against
billing_frequencystring[]optional
The membership billing frequency to filter against

Responses

200
The job was successfully queued
401
The user is unauthenticated

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

const response = await fetch('https://api.playground.try.be/customers/memberships/queue', {
  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/memberships/queue",
    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/memberships/queue', [
    '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/memberships/queue", 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 job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

get/customers/memberships/{membershipId}/change-end-date

Preview a Membership end-date change

getMembershipEndDateChangePreview

Runs the membership end-date change logic in memory without persisting it and returns the Membership as it would look after the move. Use this as a dry-run before calling actionChangeMembershipEndDate so the operator can review the downstream impact (cancelled pending charges, revised next-billing date, etc.) and confirm before committing.

Pass end_date as an ISO-8601 date in YYYY-MM-DD format, or null to preview removing the end date entirely (i.e. converting a fixed-term membership to an open-ended one). The supplied end_date must be strictly after the membership's existing start_date.

The response payload matches the regular getMembership shape — fields like status, next_billing_date and end_date will reflect the post-change state.

Path parameters

membershipIduuidrequired
The ID of the membership

Query parameters

end_datedateoptional
The proposed new end date for the membership, in YYYY-MM-DD format. Pass an empty value to preview removing the end date entirely (converting a fixed-term membership to open-ended). Must be strictly after the membership's start_date.

Responses

200
The Membership was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found
422
The request didn't pass validation

curl "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/change-end-date" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/change-end-date', {
  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/memberships/00000000-0000-0000-0000-000000000000/change-end-date",
    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/memberships/00000000-0000-0000-0000-000000000000/change-end-date', [
    '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/memberships/00000000-0000-0000-0000-000000000000/change-end-date", 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` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

post/customers/memberships/{membershipId}/change-end-date

Change a Membership's end date

actionChangeMembershipEndDate

Applies a previously previewed end-date change to the Membership and persists it. The semantics match the getMembershipEndDateChangePreview preview — pending charges whose billing period now falls outside the membership are cancelled, the next-billing date is recalculated, and the membership status is refreshed.

Pass end_date: null to remove an existing end date entirely (converting a fixed-term membership to open-ended). Any supplied end_date must be strictly after the membership's start_date.

Returns the freshly-saved Membership.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

end_datedaterequirednullable
The new end date for the membership, in YYYY-MM-DD format. Pass null to remove the end date entirely (converting a fixed-term membership to open-ended). Must be strictly after the membership's start_date.

Responses

200
The Membership 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/memberships/00000000-0000-0000-0000-000000000000/change-end-date" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "end_date": "2026-12-31"
}'

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/change-end-date', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "end_date": "2026-12-31"
  }),
})

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/memberships/00000000-0000-0000-0000-000000000000/change-end-date",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "end_date": "2026-12-31"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/change-end-date', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'end_date' => '2026-12-31'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"end_date": "2026-12-31",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/change-end-date", 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 `Membership` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "attention_reason": "no_mandate",
    "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "2026-01-15",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "2026-01-15T09:30:00+00:00",
      "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",
      "last_active_at": "2026-01-15T09:30:00+00:00",
      "email_verified_at": "2026-01-15T09:30:00+00:00",
      "last_check_in": {
        "checked_in_at": "2026-01-15T09:30:00+00:00",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    },
    "end_date": "2026-01-15T09:30:00+00:00",
    "external_ref": "EXT-12345",
    "members": [
      {
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "is_lead": true,
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_billing_date": "2026-01-15T09:30:00+00:00",
    "next_charge": {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "2026-01-15",
      "billing_period_to": "2026-01-15"
    },
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "card",
      "last_4": "string",
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "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"
    },
    "site_id": "00000000-0000-0000-0000-000000000000",
    "source": "self_signup",
    "start_date": "2026-01-15T09:30:00+00:00",
    "status": "active",
    "status_updated_at": "2026-01-15T09:30:00+00:00",
    "type": {
      "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"
    },
    "payment_details_url": "https://example.com",
    "created_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/memberships/{membershipId}/update-status

Refresh a Membership's status

actionUpdateMembershipStatus

Recomputes the derived status fields on a Membership (status and attention_reason) based on the current state of its underlying charges, billing schedule and external mandate. Use this when an out-of-band event (a manual database fix, a stuck webhook, a payment-provider reconciliation) has left the membership in an inconsistent visible state and the operator needs to nudge it back into sync.

The recomputation is deterministic — it derives the new status from the membership's existing data, not from external inputs. Pass dry_run=true to compute the new status without saving; dry_run=false (the default) persists the recomputed values.

The response always returns both the previous and the new status / attention_reason so callers can detect whether the refresh actually changed anything.

Path parameters

membershipIduuidrequired
The ID of the membership

Request body

dry_runbooleanoptional
When true, computes the new status and attention_reason but does not persist them. Use this to surface the proposed change to an operator before applying it. Defaults to false.

Responses

200
The membership status was recomputed.
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/memberships/00000000-0000-0000-0000-000000000000/update-status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": false
}'

const response = await fetch('https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/update-status', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "dry_run": false
  }),
})

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/memberships/00000000-0000-0000-0000-000000000000/update-status",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "dry_run": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/update-status', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'dry_run' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"dry_run": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/memberships/00000000-0000-0000-0000-000000000000/update-status", 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 membership status was recomputed.

{
  "data": {
    "previous_status": "active",
    "previous_attention_reason": "payment_failed",
    "new_status": "needs_attention",
    "new_attention_reason": "mandate_revoked"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

get/customers/new-membership

Get new-membership signup details

getNewMembershipDetails

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.

Query parameters

site_idstringrequired
Filter results by the site they belong to
tokenuuidoptional
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.

Responses

200
The signup form details were successfully retrieved.
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/new-membership?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/new-membership?site_id=site_abc123', {
  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/new-membership?site_id=site_abc123",
    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/new-membership?site_id=site_abc123', [
    '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/new-membership?site_id=site_abc123", 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 signup form details were successfully retrieved.

{
  "customer_details": {
    "first_name": "Alex",
    "last_name": "Morgan",
    "email": "guest@example.com",
    "phone": "+447700900000"
  },
  "types": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier",
      "rates": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 3000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "pro_rata": 1500
        }
      ]
    }
  ]
}

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