Custom plans
Customers are onboarded onto plans, each identified by an ID. Alongside the system default plans (Basic, Plus, Pro), distributors can offer custom plans tailored to their customers. Custom plans are available to the distributor and all of its partners.
Listing available plans
Plans are read-only via the API. You can list the plans available to you and retrieve the details of any individual plan:
- Distributors: List distributor plans and Get plan details
- Partners: List partner plans
Each plan includes its id, displayName, price, and the list of features
it provides.
Custom plans are configured by SafeWeb on behalf of the distributor. If you would like a new custom plan or a change to an existing one, contact your SafeWeb account manager.
Assigning a plan to a customer
When onboarding a customer, pass the plan's id as planId:
POST /api/v1/integrations/customer/onboard— see Onboard a new customerPATCH /api/v1/integrations/customer/{customerId}/info— change the plan of an existing customer, see Update customer information
The legacy planType field is deprecated. Use planId for all new
integrations.
List partner customers GET
Returns a paginated list of customers for the authenticated partner. Each customer includes only the customer ID and status. Optionally filter by customer status.
Outbound webhooks
How signed HTTP POST notifications are delivered to your receiver, what each event type contains, and how to verify responses. Management APIs live under the Partner API (per partner organization) and Distributor API (distributor-scoped webhook URLs and signing secrets).