Memberships

Membership Credit Rules

A MembershipCreditRule represents a rule for issuing credit to members of a MembershipType.

The MembershipCreditRule object

Attributes

iduuidrequired
The ID of the credit rule
membership_type_iduuidrequired
The ID of the membership type this rule relates to
membership_typeobjectoptional
coupon_idstringrequired
The ID of the coupon which will be issued
coupon_namestringrequired
The name of the coupon which will be issued
coupon_descriptionstringrequired
The description of the coupon which will be issued
roll_overbooleanrequired
If true, unused credits will roll over to the next month. Otherwise, any unused credits will be marked as expired on the next billing period.
issue_on_signupbooleanrequired
If true, the credit will be issued when new customers sign up for the given membership type. Otherwise, the credit will be issued only on the monthly billing schedule.
multi_usebooleanrequired
If true, the credit can be used an unlimited number of times until the expiry date.
for_lead_booker_onlybooleanrequired
If true, the credit will only be issued for the lead booker of an order. If false, the credit will be issued for all guests on the order, including non-members.
issuing_frequencystringrequired
The frequency that this credit is issued. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
Possible values:billing_cycleP0DP1MP3MP6MP1Y
created_atdate-timerequired
The date and time which the credit rule was created
updated_atdate-timerequired
The date and time which the credit rule was last updated

{
  "id": "00000000-0000-0000-0000-000000000000",
  "membership_type_id": "00000000-0000-0000-0000-000000000000",
  "membership_type": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Gold tier"
  },
  "coupon_id": "00000000-0000-0000-0000-000000000000",
  "coupon_name": "string",
  "coupon_description": "Free-form text from the resource.",
  "roll_over": false,
  "issue_on_signup": false,
  "multi_use": false,
  "for_lead_booker_only": false,
  "issuing_frequency": "P1M",
  "created_at": "2026-01-01T00:00:00+00:00",
  "updated_at": "2026-01-01T00:00:00+00:00"
}

get/customers/membership-credit-rules

List membership credit rules

listMembershipCreditRules

This endpoint retrieves all the membership credit rules associated with a brand, and is typically filtered by membership type.

Query parameters

brand_iduuidoptional
Filter membership credit rules by brand ID
membership_type_iduuidoptional
Filter membership credit rules by membership type ID
issue_on_signupbooleanoptional
When true, only membership credit rules that are issued on signup are returned
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The membership credit rules were successfully retrieved
401
The user is unauthenticated

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

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

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

const data = await response.json()

import httpx

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/membership-credit-rules", 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 credit rules were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "membership_type_id": "00000000-0000-0000-0000-000000000000",
      "membership_type": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Gold tier"
      },
      "coupon_id": "00000000-0000-0000-0000-000000000000",
      "coupon_name": "string",
      "coupon_description": "Free-form text from the resource.",
      "roll_over": false,
      "issue_on_signup": false,
      "multi_use": false,
      "for_lead_booker_only": false,
      "issuing_frequency": "P1M",
      "created_at": "2026-01-01T00:00:00+00:00",
      "updated_at": "2026-01-01T00:00:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

post/customers/membership-credit-rules

Create a membership credit rule

createMembershipCreditRule

This endpoint creates a new membership credit rule for a membership type.

Request body

membership_type_iduuidrequired
Identifier of the membership tier whose members will receive this credit rule. Rules are scoped to a single tier; create separate rules per tier if benefits differ.
coupon_idstringrequired
Identifier of the coupon template used when issuing the credit. Each application of the rule issues a fresh coupon code derived from this template; the template defines the discount amount, validity, and offerings.
coupon_namestringrequired
Display name shown alongside the issued coupon in the customer's account (e.g. "August spa credit"). Not the redemption code; that's generated automatically. 1-120 characters.
roll_overbooleanoptional
If true, unused credits will roll over to the next month. Otherwise, any unused credits will be marked as expired on the next billing period.
issue_on_signupbooleanoptional
If true, the credit will be issued when new customers sign up for the given membership type. Otherwise, the credit will be issued only on the monthly billing schedule.
multi_usebooleanoptional
If true, the credit can be used an unlimited number of times until the expiry date.
for_lead_booker_onlybooleanoptional
If true, the credit will only be issued for the lead booker of an order. If false, the credit will be issued for all guests on the order, including non-members.
issuing_frequencystringoptional
The frequency that this credit is issued. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
Possible values:billing_cycleP0DP1MP3MP6MP1Y
include_upcomingbooleanoptional
When true, apply the new rule to membership charges that are already scheduled but not yet billed — issuing the configured credit on the next cycle for members who joined before the rule existed. When false (default), the rule only takes effect for cycles scheduled after the rule was created; existing scheduled charges continue unchanged.

Responses

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

curl -X POST "https://api.playground.try.be/customers/membership-credit-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "membership_type_id": "00000000-0000-0000-0000-000000000000",
  "coupon_id": "5f1234567890abcdef123456",
  "coupon_name": "Monthly spa credit",
  "roll_over": false,
  "issue_on_signup": false,
  "multi_use": false,
  "for_lead_booker_only": false,
  "issuing_frequency": "billing_cycle",
  "include_upcoming": false
}'

const response = await fetch('https://api.playground.try.be/customers/membership-credit-rules', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "membership_type_id": "00000000-0000-0000-0000-000000000000",
    "coupon_id": "5f1234567890abcdef123456",
    "coupon_name": "Monthly spa credit",
    "roll_over": false,
    "issue_on_signup": false,
    "multi_use": false,
    "for_lead_booker_only": false,
    "issuing_frequency": "billing_cycle",
    "include_upcoming": 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/membership-credit-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "coupon_id": "5f1234567890abcdef123456",
        "coupon_name": "Monthly spa credit",
        "roll_over": False,
        "issue_on_signup": False,
        "multi_use": False,
        "for_lead_booker_only": False,
        "issuing_frequency": "billing_cycle",
        "include_upcoming": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/membership-credit-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'membership_type_id' => '00000000-0000-0000-0000-000000000000',
            'coupon_id' => '5f1234567890abcdef123456',
            'coupon_name' => 'Monthly spa credit',
            'roll_over' => false,
            'issue_on_signup' => false,
            'multi_use' => false,
            'for_lead_booker_only' => false,
            'issuing_frequency' => 'billing_cycle',
            'include_upcoming' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"membership_type_id": "00000000-0000-0000-0000-000000000000",
		"coupon_id": "5f1234567890abcdef123456",
		"coupon_name": "Monthly spa credit",
		"roll_over": false,
		"issue_on_signup": false,
		"multi_use": false,
		"for_lead_booker_only": false,
		"issuing_frequency": "billing_cycle",
		"include_upcoming": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/membership-credit-rules", 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 credit rule was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership_type_id": "00000000-0000-0000-0000-000000000000",
    "membership_type": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier"
    },
    "coupon_id": "00000000-0000-0000-0000-000000000000",
    "coupon_name": "string",
    "coupon_description": "Free-form text from the resource.",
    "roll_over": false,
    "issue_on_signup": false,
    "multi_use": false,
    "for_lead_booker_only": false,
    "issuing_frequency": "P1M",
    "created_at": "2026-01-01T00:00:00+00:00",
    "updated_at": "2026-01-01T00:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/customers/membership-credit-rules/{creditRuleId}

Get a single membership credit rule

getMembershipCreditRule

This endpoint retrieves a single membership credit rule by its ID.

Path parameters

creditRuleIduuidrequired
The ID of the membership credit rule

Responses

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

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

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

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

const data = await response.json()

import httpx

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/membership-credit-rules/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 credit rule was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership_type_id": "00000000-0000-0000-0000-000000000000",
    "membership_type": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier"
    },
    "coupon_id": "00000000-0000-0000-0000-000000000000",
    "coupon_name": "string",
    "coupon_description": "Free-form text from the resource.",
    "roll_over": false,
    "issue_on_signup": false,
    "multi_use": false,
    "for_lead_booker_only": false,
    "issuing_frequency": "P1M",
    "created_at": "2026-01-01T00:00:00+00:00",
    "updated_at": "2026-01-01T00:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

put/customers/membership-credit-rules/{creditRuleId}

Update a membership credit rule

updateMembershipCreditRule

This endpoint updates a membership credit rule.

Path parameters

creditRuleIduuidrequired
The ID of the membership credit rule

Request body

membership_type_iduuidoptional
Identifier of the membership tier whose members will receive this credit rule. Rules are scoped to a single tier; create separate rules per tier if benefits differ.
coupon_idstringoptional
Identifier of the coupon template used when issuing the credit. Each application of the rule issues a fresh coupon code derived from this template; the template defines the discount amount, validity, and offerings.
coupon_namestringoptional
Display name shown alongside the issued coupon in the customer's account (e.g. "August spa credit"). Not the redemption code; that's generated automatically. 1-120 characters.
roll_overbooleanoptional
If true, unused credits will roll over to the next month. Otherwise, any unused credits will be marked as expired on the next billing period.
issue_on_signupbooleanoptional
If true, the credit will be issued when new customers sign up for the given membership type. Otherwise, the credit will be issued only on the monthly billing schedule.
multi_usebooleanoptional
If true, the credit can be used an unlimited number of times until the expiry date.
for_lead_booker_onlybooleanoptional
If true, the credit will only be issued for the lead booker of an order. If false, the credit will be issued for all guests on the order, including non-members.
issuing_frequencystringoptional
The frequency that this credit is issued. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
Possible values:billing_cycleP0DP1MP3MP6MP1Y
include_upcomingbooleanoptional
When true, apply the updated rule to membership charges that are already scheduled but not yet billed — picking up rate / frequency / coupon changes for the next cycle without waiting for the new rule to organically take effect on the cycle after that. When false (default), the update only affects credits issued from the next billing cycle onwards; existing scheduled charges continue to apply the previous rule.

Responses

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

curl -X PUT "https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "membership_type_id": "00000000-0000-0000-0000-000000000000",
  "coupon_id": "5f1234567890abcdef123456",
  "coupon_name": "Monthly spa credit",
  "roll_over": false,
  "issue_on_signup": false,
  "multi_use": false,
  "for_lead_booker_only": false,
  "issuing_frequency": "billing_cycle",
  "include_upcoming": false
}'

const response = await fetch('https://api.playground.try.be/customers/membership-credit-rules/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": "00000000-0000-0000-0000-000000000000",
    "coupon_id": "5f1234567890abcdef123456",
    "coupon_name": "Monthly spa credit",
    "roll_over": false,
    "issue_on_signup": false,
    "multi_use": false,
    "for_lead_booker_only": false,
    "issuing_frequency": "billing_cycle",
    "include_upcoming": false
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "coupon_id": "5f1234567890abcdef123456",
        "coupon_name": "Monthly spa credit",
        "roll_over": False,
        "issue_on_signup": False,
        "multi_use": False,
        "for_lead_booker_only": False,
        "issuing_frequency": "billing_cycle",
        "include_upcoming": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'membership_type_id' => '00000000-0000-0000-0000-000000000000',
            'coupon_id' => '5f1234567890abcdef123456',
            'coupon_name' => 'Monthly spa credit',
            'roll_over' => false,
            'issue_on_signup' => false,
            'multi_use' => false,
            'for_lead_booker_only' => false,
            'issuing_frequency' => 'billing_cycle',
            'include_upcoming' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"membership_type_id": "00000000-0000-0000-0000-000000000000",
		"coupon_id": "5f1234567890abcdef123456",
		"coupon_name": "Monthly spa credit",
		"roll_over": false,
		"issue_on_signup": false,
		"multi_use": false,
		"for_lead_booker_only": false,
		"issuing_frequency": "billing_cycle",
		"include_upcoming": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/membership-credit-rules/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 credit rule was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "membership_type_id": "00000000-0000-0000-0000-000000000000",
    "membership_type": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Gold tier"
    },
    "coupon_id": "00000000-0000-0000-0000-000000000000",
    "coupon_name": "string",
    "coupon_description": "Free-form text from the resource.",
    "roll_over": false,
    "issue_on_signup": false,
    "multi_use": false,
    "for_lead_booker_only": false,
    "issuing_frequency": "P1M",
    "created_at": "2026-01-01T00:00:00+00:00",
    "updated_at": "2026-01-01T00:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

delete/customers/membership-credit-rules/{creditRuleId}

Delete a membership credit rule

deleteMembershipCreditRule

This endpoint deletes a membership credit rule.

Path parameters

creditRuleIduuidrequired
The ID of the membership credit rule

Responses

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

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

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

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

const data = await response.json()

import httpx

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/membership-credit-rules/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 credit rule was successfully deleted

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/customers/membership-credit-rules/{creditRuleId}/issue

Issue credits for all active memberships under a credit rule's membership type

actionIssueMembershipCreditRuleCredits

This endpoint will trigger an async job to issue credits for all active memberships under this credit rule's membership type. It will only issue credits if the customer doesn't already have an unredeemed, unexpired, unrevoked token issued by this rule.

Path parameters

creditRuleIduuidrequired
The ID of the membership credit rule

Request body

include_upcomingbooleanoptional
When true, also issue credits to memberships that are signed up under this credit rule's membership type but haven't yet been billed for the current cycle — effectively backfilling the credit for members who joined after the rule fired. When false (default), only memberships that are already in the active / billing state receive a credit.

Responses

204
The credits were successfully issued
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000/issue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "include_upcoming": false
}'

const response = await fetch('https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000/issue', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "include_upcoming": 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/membership-credit-rules/00000000-0000-0000-0000-000000000000/issue",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "include_upcoming": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"include_upcoming": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/membership-credit-rules/00000000-0000-0000-0000-000000000000/issue", 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 credits were successfully issued

// empty response

{
  "message": "Unauthenticated"
}

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

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