The Customer Subscriptions API allows administrators to retrieve aggregated subscription and license information for a given customer.
This service retrieves customer-level subscription details across different ChromeOS license types:
- Chrome Enterprise Upgrade (Annual): Information for annually recurring Chrome Enterprise Upgrade subscriptions, including total purchased, assigned, and unassigned license counts, and the subscription end date.
- Kiosk & Signage Upgrade (Annual): Information for annually recurring Kiosk & Signage Upgrade subscriptions, including license counts and the subscription end date.
- Chrome Enterprise / Education Upgrade (Perpetual): Information for perpetual licenses, including total purchased, assigned, and unassigned license counts, retired licenses (licenses that were enrolled to a device that has since been retired and cannot be transferred), and conditionally available licenses (standalone perpetual upgrades unenrolled for RMA, warranty, or repair reasons that can be reused on the same model device).
Quick overview of API methods
URLs are relative to
https://chromemanagement.googleapis.com/v1/customers/{customer_id}
| Description | Relative URL | Http method |
|---|---|---|
| Get customer subscription and license information | /subscriptionInfo | GET |
See code samples for example requests and responses.
Admin Privileges
Customer Subscriptions API respects administrator role delegation.
| Method | Admin privileges required |
|---|---|
| GetSubscriptionInfo | "Services -> Chrome Management -> Manage ChromeOS
Devices > Manage ChromeOS Devices (read only)" or "Services -> ChromeOS -> Devices -> Manage Devices -> Read" |
To manage administrator roles and privileges, visit "Admin Console -> Admin Roles".
API scopes
Chrome Management Customer Subscriptions API requires the following OAuth scope:
https://www.googleapis.com/auth/chrome.management.subscriptions.readonly
For more information, see the Authentication Overview.