Skip to content

Commit

Permalink
DOCS-3054: Add white-labeled email invoicing (#3955)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Feb 3, 2025
1 parent 1e8fb93 commit 9fa3902
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 1 deletion.
Binary file modified assets/operate/oauth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/operate/wlbilling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/manage/manage/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ date: "2025-01-22"
You can use Viam to manage your user authentication.
This guide will show you how to create a branded login screen.

{{<imgproc src="/operate/oauth.png" resize="1000x" declaredimensions=true alt="Example Oauth screenshot" style="width:600px" class="imgzoom">}}
{{<imgproc src="/operate/oauth.png" resize="1000x" declaredimensions=true alt="Example Oauth login screen" style="width:600px" class="imgzoom">}}

## Prerequisites

Expand Down
109 changes: 109 additions & 0 deletions docs/manage/manage/white-labelled-billing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
title: "White-labelled Billing"
linkTitle: "White-labelled Billing"
weight: 70
layout: "docs"
type: "docs"
description: "Set up white-labelled billing."
images: ["/operate/wlbilling.png"]
date: "2025-01-31"
---

You can use Viam to bill your customers using your own logo.
This guide will show you how to set up white-labelled billing.
Once set up:

- You will have a branded billing dashboard for each org
- Invoices will be sent from your provided support email address and will contain your provided logo

{{<imgproc src="/operate/wlbilling.png" resize="1000x" declaredimensions=true alt="Example billing dashboard" style="width:600px" class="imgzoom">}}

## Prerequisites

{{< table >}}
{{% tablestep %}}
**1. Set organization public namespace**

In the [Viam app](https://app.viam.com), navigate to your organization settings through the menu in upper right corner of the page. Create a **Public namespace**.

{{% /tablestep %}}
{{% tablestep link="/dev/tools/cli/#organizations" %}}
**2. Add your logo**

Add a logo to be displayed on the login screen for your organization.
Your logo can be up to 200KB in size and must be in PNG format.

```sh {class="command-line" data-prompt="$" data-output="2-10"}
viam organization logo set --logo-path=logo.png --org-id=<org-id>
Successfully set the logo for organization <org-id> to logo at file-path: logo.png
```

You must have [owner permissions](/manage/manage/rbac/#organization-settings-and-roles) on the organization.

{{% /tablestep %}}
{{% tablestep link="/dev/tools/cli/#organizations" %}}
**3. Add support email**

This is the email that will be shown when Viam sends emails to users on your behalf for email verification, password recovery, and other account related emails.

```sh {class="command-line" data-prompt="$" data-output="2-10"}
viam organization support-email set [email protected] --org-id=<org-id>
Successfully set support email for organization "<org-id>" to "[email protected]"
```

{{% /tablestep %}}
{{< /table >}}

## Set up custom billing

{{< table >}}
{{% tablestep link="/dev/tools/cli/#organizations" %}}
**1. Enable billing service**

Enable the billing service for your organization:

```sh {class="command-line" data-prompt="$" data-output="2-10"}
viam organizations billing-service enable --org-id=<org-id> --address="100 Center Street, New York, NY, 10001"
Successfully enabled billing service for organization "<org-id>"
```

{{% /tablestep %}}
{{% tablestep link="/dev/tools/cli/#organizations" %}}
**2. Get billing dashboard URL**

Run the following command to check your billing configuration:

```sh {class="command-line" data-prompt="$" data-output="6-10"}
viam organizations billing-service get-config --org-id="<org-id> "
Billing config for organization: <org-id>
Support Email: [email protected]
Billing Dashboard URL: https://app.viam.com/billing/logoipsum
Logo URL: https://storage.googleapis.com/viam-self-service-<org-id>/primary_logo.png

--- Billing Address ---
Address Line 1: 123 Test Street
City: New York
State: Ny
Postal Code: 10001
Country: USA
```

You can update any value after setup using `viam organizations billing-service update`.

{{% /tablestep %}}
{{% tablestep %}}
**3. Check the billing dashboard**

In the information returned in the previous step, get the billing dashboard URL.
It will be of the form `https://app.viam.com/billing/<public-namespace>`.

To see the billing dashboard for a specific organization, navigate to:

```sh {class="command-line"}
https://app.viam.com/billing/<public-namespace>?id=<org-id>
```

{{<imgproc src="/operate/wlbilling.png" resize="1000x" declaredimensions=true alt="Example billing dashboard" style="width:600px" class="imgzoom">}}

{{% /tablestep %}}
{{< /table >}}

0 comments on commit 9fa3902

Please sign in to comment.