---
title: "Customer API"
slug: "customer-api"
updated: 2026-06-23T13:09:09Z
published: 2026-06-23T13:09:09Z
canonical: "help.frisbii.com/customer-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.frisbii.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer API

The Frisbii Media Customer API is a separate REST API for customer-facing operations. Unlike the Public API — which is authenticated by your company API token — the Customer API is authenticated by the individual customer's session token. This makes it suitable for operations performed on behalf of a logged-in customer.

Interactive documentation (Swagger UI) is available at:

| Environment | URL |
| --- | --- |
| **Live** | [https://customer-api.frisbii-media.com](https://customer-api.frisbii-media.com/) |
| **Stage** | [https://customer-api.frisbii-media-stage.com](https://customer-api.frisbii-media-stage.com/) |

---

## Authentication

All Customer API requests require the customer's session token sent as the `X-plenigo-customer-session` request header:

```php
$response = $client->request('GET',
    'https://customer-api.frisbii-media.com/api/v1.0/subscriptions',
    ['headers' => ['X-plenigo-customer-session' => $customerSession]]
);
```

The `customerSession` is obtained either from:

- The `plenigo.LoginSuccess` JavaScript event (Frisbii Media SSO), or
- A `POST /sessions/customer` call with the customer's `customerId` (external user management)

See [Sessions & Transfer Tokens](/frisbii-media/docs/sessions-transfer-tokens) for details.

---

## Base URLs

| Environment | Base URL |
| --- | --- |
| **Live** | `https://customer-api.frisbii-media.com/api/v1.0/` |
| **Stage** | `https://customer-api.frisbii-media-stage.com/api/v1.0/` |

---

## Key endpoint groups

| Group | What it covers |
| --- | --- |
| **Subscriptions** | List subscriptions, get detail, cancel, undo cancellation, get cancellation reasons and dates |
| **Access Rights** | `hasAccess` — check access on behalf of the logged-in customer |
| **Personal Data** | Read and update customer profile, address, and settings |
| **Payment Methods** | List and manage the customer's payment methods |
| **Orders / Invoices** | List order history and download invoices |
| **Multi-User** | Manage users in a multi-user subscription |

---

## When to use the Customer API vs. the Public API

| Situation | Use |
| --- | --- |
| Server-side operations using your company credentials | Public API (`X-plenigo-token`) |
| Operations on behalf of a logged-in customer | Customer API (`X-plenigo-customer-session`) |
| Building a custom self-service UI | Customer API |
| Access checks in the standard checkout flow | Public API |
| Access checks when the customer session is available | Either — Customer API is simpler |

---

## Related

- [Public API (Swagger)](/frisbii-media/docs/public-api)
- [Sessions & Transfer Tokens](/frisbii-media/docs/sessions-transfer-tokens)
- [Customer Self-Service (Custom Implementation)](/frisbii-media/docs/custom-self-service) — full usage examples
- [Self-Service Portal (Snippets)](/frisbii-media/docs/self-service-portal-snippets) — the built-in alternative to a custom UI