Guide: Enable Self-Service on a CPQ Order

This guide is about orders that originated in a third-party CPQ — Salesforce CPQ, Zuora CPQ — or directly in Zuora. For Limio's own quoting capability, see Limio CPQ.

Overview

If you have a sales-assisted motion, you may want to enable some level of self-service to users that originated from a sales-assisted channel. For example, you might want them to be able to retrieve their invoices, update their payments, and purchase add-ons.

Say you have an order initiated by a CPQ, such as Salesforce CPQ or Zuora CPQ, or that has been directly taken in Zuora. The order will typically create a Subscription in Zuora. You now want to enable Limio Self-Service on that Subscription.

Separately, your provisioning system or middleware will have created a User in your Identity System, for example Auth0 or Okta, so that the User can now access your application and service.

For that User to access Limio Self-Service, you will need to:

1. Sync the Subscription in Limio and retrieve the Limio Owner of that Subscription
2. Attach the User Identity to the Limio Owner

The following diagram summarises the logic:

How to do it

Pre-requisites

• You have created a Subscription in Zuora
• You have a bearer token to access Limio's API
• You have set up your Identity System in Limio
• You have created authenticated pages in Limio

Adding the Subscription and the User Identity in Limio

To enable Limio Self-Service on a Subscription created directly in Zuora, you will need to call the Subscription Sync API to sync in Limio the subscription created in Zuora.

curl -i -X POST \
  'https://your-environment.prod.limio.com/api/plugins/zuora/sync/subscription/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

You'll then have the following response:

{
    "success": true,
    "id": "sub-140e05e7ea51dfe102f2dfc8afa457bc",
    "owner": "id-3cbac03aa7f1217570922292c074e25e"
}

Then, you will need to add the User Identity to the Limio owner by calling the External Identity API, for example submitting:

curl -i -X POST \
  'https://your-environment.prod.limio.com/api/objects/externalidentity/{owner}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id_token": {
      "iss": "limio.us.auth0.com"
      "sub": "auth0|67bf2138817314f757da5abc"
    }
  }'

User accesses a Limio Self-Service Page

From now, when the User accesses an authenticated Limio Self-Service page (e.g. /billing or /edit-plan), your Identity System will confirm to Limio the User Identity and automatically serve the correct Subscription(s) to them.