Skip to content

Update SPE docs to incorporate new Container Type Management APIs #10336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 18 additions & 100 deletions docs/embedded/administration/billing/billing.md
Original file line number Diff line number Diff line change
@@ -1,124 +1,42 @@
---
title: PAYG billing for SharePoint Embedded
description: This article explains the billing models and how to set up PAYG billing.
ms.date: 03/03/2025
title: Pay-as-you-go billing for SharePoint Embedded
description: This article explains the billing models and how to set up pay-as-you-go billing.
ms.date: 08/13/2025
ms.localizationpriority: high
---

# SharePoint Embedded billing

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd update this title to
"SharePoint Embedded billing models"


SharePoint Embedded is a consumption-based Pay-as-you-go (PAYG) offering meaning you pay only for what you use. SharePoint Embedded provides two billing models that the tenant developing the SharePoint Embedded application can select for respective container types, tailoring it to their unique business requirements. The two billing models are Standard and Pass-through billing.
SharePoint Embedded is a consumption-based pay-as-you-go offering meaning you pay only for what you use. SharePoint Embedded provides two billing models that the tenant developing the SharePoint Embedded application can select for respective container types, tailoring it to their unique business requirements. The two billing models are Standard and Passthrough billing.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"when defining their container type"

I think we need to make it clear that once the CT is created the billing model can not be changed


### Standard
## Standard billing

With the standard billing model, all consumption-based charges are directly billed to the tenant who owns or develops the application. The admin in the developer tenant must establish a valid billing profile when creating a standard container type.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should make a comment that setting up the billing profile is a step to be taken after the CT is created.
"After the CT is created, the admin in the developer tenant...."


![Standard](../../images/1bill521.png)
![Standard billing](../../images/1bill521.png)

### Pass-through
## Passthrough billing

With pass-through billing, consumption-based charges are billed directly to the tenant registered to use the SharePoint Embedded application. Admins in the developer tenant don't need to set up a billing profile when creating a pass-through SharePoint Embedded container type. Once the container type is registered in the consuming tenant, the consuming tenant admin (SharePoint Admin or Global Admin) needs to set up the billing profile in the consuming tenant to use the SharePoint Embedded application.
With passthrough billing, consumption-based charges are billed directly to the tenant registered to use the SharePoint Embedded application. Admins in the developer tenant don't need to set up a billing profile when creating a passthrough SharePoint Embedded container type. Once the container type is registered in the consuming tenant, the consuming tenant admin (SharePoint Admin or Global Admin) needs to set up the billing profile in the consuming tenant to use the SharePoint Embedded application.

![Pass Through](../../images/2bill521.png)
![PassThrough billing](../../images/2bill521.png)

## Prerequisites to create SharePoint Embedded container type
## Create a SharePoint Embedded container type

A new container type will be created using **SharePoint Online Management Shell**:
For information on how to create a container type with billing enabled, see [creating a container type](../../getting-started/containertypes.md#creating-container-types).

1. Download and install the [latest version of SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588)
1. Open SharePoint Online Management Shell from **Start** screen, type **sharepoint**, and then select **SharePoint Online Management Shell**.
1. Connect to SPO service using `Connect-SPOService` cmdlet by providing admin credentials associated with tenancy. For information on [how to use Connect-SPOService](/powershell/module/sharepoint-online/connect-sposervice), refer the linked documentation.
## View & edit billing properties of standard container type

### Tenant requirements
You can view the properties of a container type and associated billing properties by using the Container Type APIs:

- An active instance of SharePoint is required in your Microsoft 365 tenant.
- Users who will be authenticating into SharePoint Embedded Container Types and Containers must be in Entra ID (Members and Guests)
- [List container types](/graph/api/filestorage-list-containertypes)
- [Get container type](/graph/api/filestoragecontainertype-get)

> [!NOTE]
> An Office license is not required to collaborate on Microsoft Office documents stored in a container.
To update the billing properties on a container type with standard billing, see [set the billing profile](../../getting-started/containertypes.md#set-the-billing-profile).

### Roles and Permissions
## Set up billing for passthrough container types in consuming tenant

- The admin who sets up the billing relationship for SharePoint Embedded needs to have owner or contributor permissions on the Azure subscription.
- Admin needs to have a SharePoint Embedded Administrator or Global Admin role to operate billing cmdlets.

### Azure Subscription

For the Standard Billing container type, the developer admin needs to set up:

- An existing SharePoint tenancy
- An Azure subscription in the tenancy
- A resource group attached to the Azure subscription

## Set up a Standard Billing container type

For standard billed container types, developer admins should set up billing in their tenant. The Microsoft 365 SharePoint Embedded Administrator serves as the developer admin. Global Administrators in Microsoft 365 can assign users the SharePoint Embedded Administrator role, which already has all the permissions of the SharePoint Embedded Administrator role. The SharePoint Embedded Admin role is available in Microsoft Entra and Microsoft 365 Admin Center.

SharePoint Embedded Admin can create a container type using the `New-SPOContainerType` cmdlet by providing an Azure subscription, the resource group associated with the subscription, and a region.

- If you don't have an Azure subscription, you can create one by following the steps here to [create an Azure subscription in your tenancy](/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions),
- If you don't have a resource group, you can create one by following the steps here to [create a resource group](/azure/azure-resource-manager/management/manage-resource-groups-portal)

```powershell
New-SPOContainerType -ContainerTypeName <ContainerTypeName>
-OwningApplicationId <OwningApplicationId>
-AzureSubscriptionId <AzureSubscriptionId>
-ResourceGroup <ResourceGroup>
-Region <Region>
```

> [!IMPORTANT]
> Every container type must have an owning application.
>
> A single-owning app can only own one container type at a time.
>
> An Azure subscription can be attached to any number of container types.

### View & Edit billing properties of Standard container type

You can view the properties of a container type and associated billing properties by using one of the two PowerShell cmdlets:

1. See all container types and billing properties except associated region:

```powershell
Get-SPOContainerType
```

1. See billing properties associated with a container type including region:

```powershell
Get-SPOContainerType -ContainerTypeId <ContainerTypeId>
```

1. Update Azure subscription or resource group associated with a container type:

```powershell
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> [-AzureSubscriptionId <AzureSubscriptionId>] [-ResourceGroup <ResourceGroup>]
```


## Set up a Pass-through Billing container type

For Pass-through Billing container types, the developer admin doesn't have to set up billing in the developer tenant. SharePoint Embedded Admin can create container type using `New-SPOContainerType` cmdlet with `isPassThroughBilling` specified.

```powershell
New-SPOContainerType -ContainerTypeName <ContainerTypeName>
-OwningApplicationId <OwningApplicationId>
-isPassThroughBilling
```

### [Set Up Guide in Consuming Tenant Admin Center](../consuming-tenant-admin/cta.md#set-up-billing-for-pass-through-app)

1. In [Microsoft 365 admin center](https://admin.microsoft.com/), select **Setup**, and the view the **Files and Content** section. Select **Automate Content with Microsoft Syntex.**

![Microsoft 365 admin center Files and Content](../../images/DTCBilling1.png)

1. Select **Go to Syntex settings**.
1. Select **Apps** under **Syntex services for**, select **SharePoint Embedded**

![Microsoft 365 admin center SharePoint Embedded Billing setting](../../images/DTCBilling2.png)

1. Follow the instructions on the **SharePoint Embedded** flyer to turn on SharePoint Embedded apps.
To set up billing for a passthrough container type in the consuming tenant, see the [setup guide in the consuming tenant Admin Center](../consuming-tenant-admin/cta.md#set-up-billing-for-passthrough-app).

## SharePoint Embedded meters

Expand Down
7 changes: 3 additions & 4 deletions docs/embedded/administration/billing/meters.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title for the "Pay as you go message" doesn't seem related to the description, at least to me.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Egress section, it says that "to the data downloaded from the SharePoint Embedded platform to the customer's client device such as a desktop or mobile device.".

We have to be a bit more careful with this, to also include the case where an SPE service application makes calls that translate into Egress, but doesn't necessarily downloads that data to any end user device.

Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@ ms.date: 04/30/2025
ms.localizationpriority: high
---

# SharePoint Embedded Billing Meters
# SharePoint Embedded billing meters

SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). Both Standard Billing container type and Pass-through Billing container type will use the same meters.
SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). Both standard billing container type and passthrough billing container type will use the same meters.

SharePoint Embedded has three billing meters as shown. Refer to the [product page](https://adoption.microsoft.com/en-us/sharepoint/embedded/) for pricing details.


## Storage

Storage consumption meters in SharePoint Embedded apply to the storage used by files and documents along with their metadata and versions. Storage consumption also includes all content in the recycle bin and deleted container collection within SharePoint Embedded.

## API Transactions
## API transactions

Each Microsoft Graph call made explicitly by the SharePoint Embedded application is counted as one transaction and customers are billed based on the transaction count. See the [examples](/graph/api/resources/filestoragecontainer) of Microsoft Graph calls that can be made by a SharePoint Embedded application.

Expand Down
23 changes: 16 additions & 7 deletions docs/embedded/administration/consuming-tenant-admin/cta.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Consuming Tenant Admin
description: This article describes the role and responsibilities of Consuming Tenant Admin in SharePoint Embedded.
ms.date: 03/03/2025
ms.date: 08/13/2025
ms.localizationpriority: high
---

# Consuming Tenant Admin

> [!IMPORTANT]
> Assign the SharePoint Embedded Administrator role available in M365 Admin Center or Microsoft Entra to execute SharePoint Embedded Container cmdlets mentioned in this article.
> Assign the SharePoint Embedded Administrator role available in M365 Admin Center or Microsoft Entra ID to execute SharePoint Embedded Container cmdlets mentioned in this article.
>
> Global Administrators can continue to execute SharePoint Embedded container cmdlets.
>
Expand All @@ -18,13 +18,22 @@ The organizations that use the SharePoint Embedded applications on their Microso

## Consuming Tenant Admin Role

Microsoft 365 SharePoint Embedded Administrator serves as the consuming tenant admin. Global Administrators in Microsoft 365 can assign users the SharePoint Embedded Administrator. The Global Administrator role already has all the permissions of the SharePoint Embedded Administrator role. The SharePoint Embedded Role is available in Microsoft Entra and Microsoft 365 Admin Center.
Microsoft 365 SharePoint Embedded Administrator serves as the consuming tenant admin. Global Administrators in Microsoft 365 can assign users the SharePoint Embedded Administrator. The Global Administrator role already has all the permissions of the SharePoint Embedded Administrator role. The SharePoint Embedded Role is available in Microsoft Entra ID and Microsoft 365 Admin Center.
For information on [SharePoint Embedded Admin](../adminrole.md)

## Administration Tools

Consuming tenant admins can manage SharePoint Embedded applications with the following options:

### Microsoft Graph APIs

The [fileStorageContainerTypeRegistration](/graph/api/resources/filestoragecontainertyperegistration) resource represents the registration of a container type in a consuming tenant. To manage all container type registrations in the consuming tenant, the `FileStorageContainerTypeReg.Manage.All` delegated permission is required.

- [List container type registrations](/graph/api/filestorage-list-containertyperegistrations)
- [Get container type registrations](/graph/api/filestoragecontainertyperegistration-get)
- [Update container type registrations](/graph/api/filestoragecontainertyperegistration-update)
- [Delete container type registrations](/graph/api/filestorage-delete-containertyperegistrations)

### SharePoint Online Management Shell

On PowerShell, the SharePoint Embedded Admin can run the following cmdlets:
Expand All @@ -48,19 +57,19 @@ The SharePoint Embedded Admin can access the Active and Deleted containers page

For information on consuming tenant admin in SharePoint Admin see [container management](ctaUX.md)

## Security and Compliance Administration
## Security and compliance administration

SharePoint Embedded uses Microsoft’s comprehensive compliance and data governance solutions to help organizations manage risks, protect, and govern sensitive data, and respond to regulatory requirements. Security and compliance solutions work in a similar manner in the SharePoint Embedded platform as they do today in the Microsoft 365 platform so that data is stored in a secure, protected way that meets customers’ business and compliance policies while making it easy for Compliance and SharePoint Administrators to enforce critical security and compliance policies on the content. For information on supported security and compliance capabilities, see [Security and Compliance](../../compliance/security-and-compliance.md).

## Set Up Billing for Pass-through App
## Set up billing for passthrough container type

To use Pass-through SharePoint Embedded App, SharePoint Embedded Admin needs to set up Microsoft Syntex billing in [Microsoft 365 admin center](https://admin.microsoft.com/). No user can access any Pass-through SharePoint Embedded apps before a valid billing is set up for the SharePoint Embedded platform.
To use passthrough billing SharePoint Embedded app, SharePoint Embedded Admin needs to set up Microsoft Syntex billing in [Microsoft 365 admin center](https://admin.microsoft.com/). No user can access any passthrough SharePoint Embedded apps before a valid billing is set up for the SharePoint Embedded platform.

### [Meters](../billing/meters.md)

SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/).

SharePoint Embedded has three billing meters as shown. Refer to the [product page](https://adoption.microsoft.com/en-us/sharepoint/embedded/) for pricing details
SharePoint Embedded has three billing meters as shown. Refer to the [product page](https://adoption.microsoft.com/en-us/sharepoint/embedded/) for pricing details

| SharePoint Embedded Service Meters | Meter Unit |
| :--------------------------------: | :------------: |
Expand Down
Loading