Limio
WebsiteHelp Desk
  • Home
  • Custom Components
    • Getting Started with Custom Components
    • Connecting External CI
    • Development Guidelines
    • Prop Types
    • Custom subcomponents
    • Connecting to External Service
  • Limio SDK
    • Getting Started with Limio SDK
    • Basket (Cart), Promo Code
    • Page, Offer, and Add-On
    • User, Subscription, Invoice & Address
    • Advanced Methods
      • Express Checkout
      • Core Utilities and Helpers
  • API Docs
    • Authentication Schemes
      • OAuth Bearer Token
      • API Key (Catalog API-only)
    • Catalog API
    • Promo Codes API
    • Order API
    • Objects API
    • Shop Build & Publish API
    • External Identities API
  • Webhooks
    • Using Webhooks
    • Webhooks Overview
  • I want to...
    • Retrieve abandoned baskets
    • Enable self-service on a CPQ order
Powered by GitBook
On this page
  • Overview
  • How to do it
  • Pre-requisites
  • Adding the Subscription and the User Identity in Limio
  • User accesses a Limio Self-Service Page

Was this helpful?

  1. I want to...

Enable self-service on a CPQ order

PreviousRetrieve abandoned baskets

Last updated 4 days ago

Was this helpful?

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

Adding the Subscription and the User Identity in Limio

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"
}
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.

You have a to access Limio's API

You have in Limio

You have created in Limio

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

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

bearer token
set up your Identity System
authenticated pages
Subscription Sync API
External Identity API