...
| Table of Contents | ||
|---|---|---|
|
...
1 - Terminology
| Concept | Explanation |
|---|---|
| App Provider | An App Provider is a commercial entity which has a legal agreement with Maestrano and/or you directly and which is authorised to publish applications on your platform. In order to publish application(s) to your platform the App Provider will have registered its application(s) on the Maestrano Developer Platform and the Maestrano team will have activated it for your platforms. App Providers receive a percentage of the revenue generated through the platforms by Customers purchasing their applications. |
| Customer | A customer is an organisation with multiple members which has entered a credit in the system and is using the platform via the frontend or portal that you provide. A Customer uses applications provided by App Providers. A Customer always belong to one and only one Tenant. |
| Tenant | A Tenant is a platform owner. The Maestrano solution is multi-tenant meaning that multiple frontends/portals can be managed by a single Maestrano Platform. Each of these frontends will constitute a Tenant. Each Tenant will have a set of API keys to access the Maestrano Hub APIs. Each Tenant will have its own set of applications and customers. Tenants are virtually isolated from each other. If Tenant A and Tenant B co-exist on the same Maestrano Platform then Tenant A will not be authorised to access Tenant B's resources (customers, invoices etc.) via API. Tenants receive a percentage of the revenue generated on their platform. The revenue is shared between the Tenant, Maestrano and the App Providers. |
2 - Billing Timeline
The Maestrano billing and commissioning process is composed of three key milestones:
...
The diagram below summarises the overall Billing & Commission timeline:
3 - Accessing billing data
3.1 - As an App Provider
As an App Provider you send bills to the platform as Customers use your app (monthly subscription, in-app purchase etc.). Bills you send will automatically be assigned a status of submitted. Bills in a submitted status will stay in that state until they get invoiced (on the 25th of the month) or cancelled (by you before the 25th).
You can retrieve bills in a certain status by filtering your calls on the Maestrano Account API. Please refer to each Maestrano SDK documentation to know the specifics related to filtering Bills by status.
3.2 - As a Tenant
As a Tenant you can retrieve the invoices generated by the platform using the Maestrano Hub API. Please refer to the Maestrano Hub documentation and more specifically to the invoices section to get examples of invoice responses from the API.
3.3 - Webhooks (only available to Tenants)
As a Tenant you can also receive invoices via webhook as soon as they are generated by the Maestrano Billing Engine. The webhook payload follows the same format as the one described in the invoices section of the Maestrano Hub API.
...