Changelog

The product API (/api/v1) and webhook events change only additively. Breaking changes get a new version or event type, with at least 12 months' notice; they are announced here, in the Admin Portal and by email.

2026-10-08Copy Anchor Link

• Documentation site. This site: getting started, concepts, guides, the generated API reference, webhook events, a page for every error code at /errors/{code}, and guides to the Admin Portal and the Customer Portal.

2026-10-07Copy Anchor Link

• Editions. Products now have editions (functional tiers) between products and plans. Additive changes: edition in the entitlement answer; editions and each plan's edition in the catalogue; editionSlug (and previousEditionSlug on subscription.plan_changed) in webhook events. Existing plans each received their own edition, so no answer changed until you group plans.
• Billing model on plans. marketplace.perUser is now echoed from each plan's billing model (FlatRate or PerUser).

2026-10-05Copy Anchor Link

• Metered usage intake. POST /api/v1/metered-usage reports usage on Microsoft Marketplace custom meters (scope usage:write, app role Usage.Write.All).

EarlierCopy Anchor Link

• Product API v1. Entitlements (GET /api/v1/entitlements/{tenantId}), user eligibility (GET and POST …/eligibility, including ConsentRequired for Microsoft-managed licences), the catalogue (/api/v1/catalogue/products), Entra application proof of control (POST /api/v1/client-credentials/verify), and outbound webhooks signed with Standard Webhooks.