Document the retrieval of Tenant Billing details exposed by Identity Server

[ymgupta]

Summary

The Tenant Billing Server fetches all the entity details (devices, gateways, etc) by acting as a gateway between The Things Stack and the payment backends (such as Stripe). In order to get all the details of all entities for billing purposes, the user can manually access them from the identity server and does not need to run the Tenant Billing Server.

Ref: https://github.com/TheThingsIndustries/lorawan-stack-support/issues/662#issuecomment-989828656

Why do we need this?

To let the users know how to fetch the billing data from TTS to use it in their billing backends.

What is already there? What do you see now?

Documentation on using Stripe as a billing backend and configuring TBS.

Ref: https://www.thethingsindustries.com/docs/reference/components/tenant-billing-server/

What is missing? What do you want to see?

• Instructions on manually fetching the billing data from TTSE using the CLI and the API.

  • The API is exposed by the Identity Server and uses a tenant-admin-key (the one in the IS configuration) to get those details. So, update the documentation to redirect to the tenant APIs & CLI to get the total billing details.
    • Ref: https://www.thethingsindustries.com/docs/reference/api/tenant/
    • Ref: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_tenants_get-registry-totals/

• Mention the below flow for fetching the billing details manually.

  • Use API TenantRegistry.List to obtain the list of tenants
  • Use API TenantRegistry.GetRegistryTotals for each tenant to get the total number of devices
  • Update the billing backend with the number of billed end devices

• In general options configuration mark as deprecated to the parameter tbs.reporter-address-regexps.
  Ref: https://www.thethingsindustries.com/docs/reference/configuration/tenant-billing-server/#general-options

How do you propose to document this?

...

Can you do this yourself and submit a Pull Request?

No