SAFE Billing Platform Documentation
Comprehensive guides for every part of the platform, hosted on a dedicated site and kept current with each release.
What does the SAFE documentation cover?
The SAFE Billing Platform documentation covers four areas: user guides for billing-team tasks, admin guides for configuration and security, an API reference for developers, and integration guides for carriers, payment providers, and third-party tools. Everything lives at documentation.billingplatform.uk.
It sits on its own site, separate from this product site, so it can grow without cluttering the marketing pages and so search results land readers on the right kind of page for what they actually want.
Each section opens with a getting-started page that sets out the modules involved and the order to work through them, so you are not assembling the workflow from individual reference pages.
Reading paths by role
The same documentation suits three different readers. Pick the path that matches what you are trying to do, rather than reading top to bottom.
If you have just been handed SAFE and need to run your first billing cycle, start at the getting started guide. It walks through the first login, importing your first CDRs, and raising your first invoice in order.
If you are wiring SAFE into a CRM, accounting tool, or provisioning system, jump straight to the API reference. The authentication and endpoint pages cover everything most teams need; the integration section covers the larger setups.
If you own SAFE inside your business, the administrative guides cover user roles, security settings, and backup. The integrations section covers payment providers, accounting software and other connected services.
Documentation by area
User Guides
Step-by-step instructions for the day-to-day jobs your billing team runs, from the first login through to sending out a full month-end billing run.
- ✓Getting Started Guide
- ✓CDR Processing Workflow
- ✓Invoice Creation Guide
- ✓Payment Collection Setup
Administrative Guides
Set-up and ongoing administration: user roles, system settings, security controls, and backup, written for the person who owns the platform inside your business.
- ✓User Management
- ✓System Configuration
- ✓Security Settings
- ✓Backup and Recovery
API Documentation
REST API reference for developers connecting SAFE to your CRM, provisioning system, or accounting tool, with worked examples for the endpoints customers use most.
- ✓API Overview
- ✓Authentication
- ✓Endpoint Reference
- ✓Code Examples
Integration Guides
How to wire SAFE up to your carriers, payment providers, and accounting software. Includes GoCardless and Stripe setup walkthroughs.
- ✓Carrier Integration
- ✓GoCardless Setup
- ✓Stripe Integration
- ✓Accounting Software Connections
How we keep it current
The documentation ships alongside the platform release, not on a separate cycle, so reference pages are updated as features change. Larger changes are written up in the Feature Spotlight at release time for the longer story behind the change.
If you find anything in the documentation that does not match the platform, please tell us through the contact page. It reaches the same team that writes the docs.
Access full documentation
Visit the dedicated documentation site for the complete, up-to-date guide to the SAFE Billing Platform.
Visit Documentation SiteDocumentation Questions
How often is the documentation updated?
Is there a printable version?
How do I search the documentation?
What does the API reference cover?
Get Help With Your First Steps
We can walk your team through the first steps on the platform and point you to the guides that cover your setup.