mailboxPlans

Mailbox Plans. Default-setting templates applied when new mailboxes are provisioned. The mailboxPlans entity set lives under /exchange/v1.0/mailboxPlans in the Mailbox settings category.

Fact	Value
Path	`/exchange/v1.0/mailboxPlans`
Category	Mailbox settings
Tier	Tier 9, Hybrid and organization
Read role	`Device.Read.All` (Community)
Write role	none (read-only)
Backing cmdlets	Get-MailboxPlan, Set-MailboxPlan

Routes

Method	Path	Synopsis	Role	Plan
GET	`/exchange/v1.0/mailboxPlans`	List mailboxPlans entries.	`Device.Read`	Community
GET	`/exchange/v1.0/mailboxPlans/{key}`	Get a single mailboxPlans entry by Identity.	`Device.Read`	Community

GET /exchange/v1.0/mailboxPlans

List mailboxPlans entries.

Backing cmdlet: Get-MailboxPlan. Role: Device.Read (Community).

Parameter	In	Type	Required	Description
`allMailboxPlanReleases`	query	bool (switch)		Include mailbox plans used in previous versions of the service, not just the current version. Maps -AllMailboxPlanReleases on Get-MailboxPlan.
`all`	query	bool (switch)		Return all results instead of the EXO default of 1000. Maps -ResultSize Unlimited on Get-MailboxPlan; prevents silent truncation in large tenants.

List mailboxPlans

Stub auto-generated example for the mailboxPlans collection. Backing cmdlet: Get-MailboxPlan. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mailboxPlans?$top=3 HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxPlans",
  "value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

GET /exchange/v1.0/mailboxPlans/{key}

Get a single mailboxPlans entry by Identity.

Backing cmdlet: Get-MailboxPlan. Role: Device.Read (Community).

Get a single mailboxPlans entry

Stub auto-generated example for GET /mailboxPlans/{key}. Backing cmdlet: Get-MailboxPlan with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mailboxPlans/{key} HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxPlans/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.