Customers

Customer Credits

A CustomerCredit represents a coupon credit issued to a customer — either automatically as a recurring membership benefit or manually as a one-off (e.g. a goodwill gesture). Each credit references the underlying Coupon that defines what it entitles the customer to.

get/customers/customers/{customerId}/credits

List Customer Credits

listCustomerCredits

Retrieves a paginated list of credits issued to the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Query parameters

per_pageintegeroptional
The number of results to return per page
pageintegeroptional
The page to retrieve results from
redeemedbooleanoptional
Whether to include redeemed credits
expiredbooleanoptional
Whether to include expired credits
revokedbooleanoptional
Whether to include revoked credits
multi_usebooleanoptional
Filter on credits that are multi-use or single-use

Responses

200
The customer's credits were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/credits', {
  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/customers/00000000-0000-0000-0000-000000000000/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('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/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("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/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 customer's credits were successfully retrieved

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "coupon_name": "Free 30 minute massage",
      "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
      "multi_use": true,
      "customer_id": "000000-000000-000000-000000",
      "membership_id": "000000-000000-000000-000000",
      "coupon_code": "string",
      "revenue": 2495,
      "issued_at": "2021-01-01T00:00:00.000Z",
      "expires_at": "2021-01-01T00:00:00.000Z",
      "redeemed_at": "2021-01-01T00:00:00.000Z",
      "revoked_at": "2026-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

{
  "message": "Unauthenticated"
}

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

post/customers/customers/{customerId}/credits

Issue a Customer Credit

createCustomerCredit

Issues a one-off credit to the customer. Use this endpoint to grant an ad-hoc coupon credit; recurring credits typically come from membership credit rules.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Request body

coupon_iduuidrequired
The Coupon template that defines what the credit entitles the customer to spend (offering, monetary value, redemption rules). Every credit is issued from a coupon — there is no free-form credit grant.
customer_iduuidrequired
The Customer the credit is issued to. Credits are scoped to a single customer and cannot be transferred between customers later.
membership_iduuidoptional
The Membership the credit relates to, if the credit is being issued as part of a membership benefit (e.g. a monthly recurring complimentary treatment). Omit for one-off credits unrelated to a membership.
expiry_datedate-timeoptional
The datetime which the credit will expire
revenueintegeroptional
The amount of revenue that should be allocated when this credit is redeemed, in the smallest unit of currency.

Responses

201
The customer's credit 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/customers/00000000-0000-0000-0000-000000000000/credits" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "coupon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "membership_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "expiry_date": "2021-03-10T00:00:00.000Z",
  "revenue": 2495
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/credits', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "coupon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "membership_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "expiry_date": "2021-03-10T00:00:00.000Z",
    "revenue": 2495
  }),
})

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/customers/00000000-0000-0000-0000-000000000000/credits",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "coupon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "membership_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "expiry_date": "2021-03-10T00:00:00.000Z",
        "revenue": 2495
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/credits', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'coupon_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'customer_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'membership_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'expiry_date' => '2021-03-10T00:00:00.000Z',
            'revenue' => 2495
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"coupon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"membership_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"expiry_date": "2021-03-10T00:00:00.000Z",
		"revenue": 2495,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/credits", 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 customer's credit was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "coupon_name": "Free 30 minute massage",
    "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
    "multi_use": true,
    "customer_id": "000000-000000-000000-000000",
    "membership_id": "000000-000000-000000-000000",
    "coupon_code": "string",
    "revenue": 2495,
    "issued_at": "2021-01-01T00:00:00.000Z",
    "expires_at": "2021-01-01T00:00:00.000Z",
    "redeemed_at": "2021-01-01T00:00:00.000Z",
    "revoked_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"
}

get/customers/customers/{customerId}/credits/{creditId}

Get a Customer Credit

getCustomerCredit

Retrieves a single customer credit by its ID.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
creditIduuidrequired
The unique identifier of the customer credit this operation is scoped to.

Responses

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

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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 customer's credit was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "coupon_name": "Free 30 minute massage",
    "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
    "multi_use": true,
    "customer_id": "000000-000000-000000-000000",
    "membership_id": "000000-000000-000000-000000",
    "coupon_code": "string",
    "revenue": 2495,
    "issued_at": "2021-01-01T00:00:00.000Z",
    "expires_at": "2021-01-01T00:00:00.000Z",
    "redeemed_at": "2021-01-01T00:00:00.000Z",
    "revoked_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

delete/customers/customers/{customerId}/credits/{creditId}

Revoke a Customer Credit

deleteCustomerCredit

Revokes the given customer credit so that it can no longer be redeemed. Credits that have already been redeemed cannot be revoked.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
creditIduuidrequired
The unique identifier of the customer credit this operation is scoped to.

Responses

200
The customer's credit was successfully retrieved
400
The credit couldn't be revoked
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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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/customers/00000000-0000-0000-0000-000000000000/credits/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 customer's credit was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "coupon_name": "Free 30 minute massage",
    "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
    "multi_use": true,
    "customer_id": "000000-000000-000000-000000",
    "membership_id": "000000-000000-000000-000000",
    "coupon_code": "string",
    "revenue": 2495,
    "issued_at": "2021-01-01T00:00:00.000Z",
    "expires_at": "2021-01-01T00:00:00.000Z",
    "redeemed_at": "2021-01-01T00:00:00.000Z",
    "revoked_at": "2026-01-15T09:30:00+00:00"
  }
}

// empty response

{
  "message": "Unauthenticated"
}

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

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