Customer portal

The customer portal is a billing page that Solvimon builds and hosts for one of your customers. It shows what they are subscribed to, what they have used, and what they have been invoiced, and it lets them pay and keep their billing details up to date.

What it does

The portal gives one customer a view of their own billing. Depending on how you configure the link, it can show:

And it can let them:

Each link is created for one specific customer and carries a token that identifies them, so they see their own data without logging in.

When to use it

Use the portal to take routine billing questions off your support queue. Most billing tickets are things a customer can do themselves: fetching an invoice, checking what they pay for, correcting a VAT number, or paying something overdue.

Two common ways to use it:

• A “Manage billing” button in your product. Create a link when the customer clicks it and send them straight there. They are already signed in on your side, so the link never travels anywhere else.
• A link in an email. Useful for chasing payment: allow paying an open invoice, and the customer can settle it directly from the email.

If you would rather show this inside your own product, the SDK’s Customer overview screen renders the same data as components you mount yourself. That screen has its own fixed layout and does not read the settings below.

Create a portal link

A portal link is a portal URL of type CUSTOMER. display chooses the sections, and options chooses the actions.

$
curl -X POST https://test.api.solvimon.com/v1/portal-urls \
>
  -H "X-API-KEY: <apiKey>" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "type": "CUSTOMER",
>
    "customer_id": "cust_example",
>
    "customer": {
>
      "display": {
>
        "pricing_plan_subscriptions": true,
>
        "invoices": true,
>
        "usage": true,
>
        "payment_acceptors": true
>
      },
>
      "options": {
>
        "edit_customer_details": true,
>
        "download_invoice": true,
>
        "pay_open_invoice": true
>
      }
>
    }
>
  }'

1
{
2
  "object_type": "PORTAL_URL",
3
  "id": "purl_example",
4
  "type": "CUSTOMER",
5
  "customer_id": "cust_example",
6
  "status": "PUBLISHED",
7
  "url": "https://portal.solvimon.com/...",
8
  "customer": {
9
    "display": {
10
      "pricing_plan_subscriptions": true,
11
      "invoices": true,
12
      "usage": true,
13
      "payment_acceptors": true
14
    },
15
    "options": {
16
      "edit_customer_details": true,
17
      "download_invoice": true,
18
      "pay_open_invoice": true
19
    }
20
  }
21
}

Send the customer the url from the response.

Both objects are set per link, so the same customer can get a full-access link in your product and a read-only link by email. For a read-only view, leave the sections on and turn the actions off:

1
{
2
  "display": { "pricing_plan_subscriptions": true, "invoices": true, "usage": true, "payment_acceptors": false },
3
  "options": { "edit_customer_details": false, "download_invoice": true, "pay_open_invoice": false }
4
}

See Create a portal URL for the full schema.

Revoking a link

Because the link opens one customer’s billing data without a login, treat it like a credential: send it to the customer rather than publishing it. If it reaches the wrong person, revoke it:

$
curl -X POST https://test.api.solvimon.com/v1/portal-urls/purl_example/revoke \
>
  -H "X-API-KEY: <apiKey>"

The link then reports status: "REVOKED" and no longer opens. Links stay valid until revoked, so generate a fresh one per visit for anything sensitive rather than storing one per customer.

Via Desk

You do not need the API. Portal links can be generated from a customer’s detail page in Desk, which is the quickest route for a support agent handling a one-off request.

Things to know

• One customer per link. Parent and child customers each need their own link.
• Available payment methods depend on the PSP. What a customer can add, change, or remove comes from the connected provider. See Payment Options.
• Cancellation is a platform setting. Whether customers can cancel a subscription is configured platform-wide, not per link. Check it before telling customers they can cancel here.
• Edits apply going forward. A billing address change affects future invoices, not ones already finalised.