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 | |
Stage |
Authentication
All Customer API requests require the customer's session token sent as the X-plenigo-customer-session request header:
$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.LoginSuccessJavaScript event (Frisbii Media SSO), orA
POST /sessions/customercall with the customer'scustomerId(external user management)
See Sessions & Transfer Tokens for details.
Base URLs
Environment | Base URL |
|---|---|
Live |
|
Stage |
|
Key endpoint groups
Group | What it covers |
|---|---|
Subscriptions | List subscriptions, get detail, cancel, undo cancellation, get cancellation reasons and dates |
Access Rights |
|
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 ( |
Operations on behalf of a logged-in customer | Customer API ( |
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
Customer Self-Service (Custom Implementation) — full usage examples
Self-Service Portal (Snippets) — the built-in alternative to a custom UI