MspsLicenses
listMspLicenses
Return MSP license entitlement, subscription, amendment, and usage summary information.
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
msp_id*string
Format
uuidResponse Body
curl -X GET "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/licenses"{ "amendments": [ { "created_time": 1644684842, "end_time": 1744156799, "id": "ff0a14f6-1234-5678-90ab-c8e64d4bc6c6", "modified_time": 1644684842, "quantity": -1, "start_time": 1632873600, "subscription_id": "VNA-000000af", "type": "SUB-VNA" }, { "created_time": 1644684842, "end_time": 1744156799, "id": "c1c28812-1234-5678-90ab-dc95680da61e", "modified_time": 1644684842, "quantity": -1, "start_time": 1632873600, "subscription_id": "MAN-000008be", "type": "SUB-MAN" }, { "created_time": 1644684842, "end_time": 1744243199, "id": "96c0a41f-1234-5678-90ab-afe74817e9fd", "modified_time": 1644684842, "quantity": -1, "start_time": 1586476800, "subscription_id": "EX24-000000bc", "type": "SUB-EX24" } ], "entitled": { "SUB-ENG": 26, "SUB-EX24": 9, "SUB-MAN": 26, "SUB-VNA": 26 }, "licenses": [ { "created_time": 1555353534, "end_time": 1586822399, "id": "693a41a6-1234-5678-90ab-f53dbd3a31c0", "modified_time": 1555353534, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 2, "remaining_quantity": 0, "start_time": 1555286400, "subscription_id": "VNA-000000aa", "type": "SUB-VNA" }, { "created_time": 1576132516, "end_time": 1586822399, "id": "656607cf-1234-5678-90ab-fc9035614ea5", "modified_time": 1576132516, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 8, "remaining_quantity": 0, "start_time": 1576022400, "subscription_id": "VNA-000000ab", "type": "SUB-VNA" }, { "created_time": 1579204568, "end_time": 1730764800, "id": "db50d0bc-1234-5678-90ab-e439958cb06b", "modified_time": 1579204568, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 2, "remaining_quantity": 2, "start_time": 1572998400, "subscription_id": "MAN-000000ac", "type": "SUB-MAN" }, { "created_time": 1579204568, "end_time": 1730764800, "id": "2ff9e84a-1234-5678-90ab-fb9ec0726e01", "modified_time": 1579204568, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 2, "remaining_quantity": 2, "start_time": 1572998400, "subscription_id": "ENG-000000ad", "type": "SUB-ENG" }, { "created_time": 1579204568, "end_time": 1730764800, "id": "16df7ea6-1234-5678-90ab-78018cd4024d", "modified_time": 1579204568, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 2, "remaining_quantity": 2, "start_time": 1572998400, "subscription_id": "VNA-000000ae", "type": "SUB-VNA" }, { "created_time": 1586237081, "end_time": 1744243199, "id": "1b6f68d5-1234-5678-90ab-70d3e6d18c73", "modified_time": 1586237081, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 14, "remaining_quantity": 14, "start_time": 1586563200, "subscription_id": "VNA-000000af", "type": "SUB-VNA" }, { "created_time": 1586237097, "end_time": 1744243199, "id": "1375c9bf-1234-5678-90ab-9c636708c89e", "modified_time": 1586237097, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 14, "remaining_quantity": 14, "start_time": 1586563200, "subscription_id": "MAN-000000ba", "type": "SUB-MAN" }, { "created_time": 1586237137, "end_time": 1744243199, "id": "5974e979-1234-5678-90ab-438f833ec1c9", "modified_time": 1586237137, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 14, "remaining_quantity": 14, "start_time": 1586563200, "subscription_id": "ENG-000000bb", "type": "SUB-ENG" }, { "created_time": 1629947267, "end_time": 1744243199, "id": "340a9cb3-1234-5678-90ab-b009344dbf3c", "modified_time": 1629947267, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 10, "remaining_quantity": 9, "start_time": 1586476800, "subscription_id": "EX24-000000bc", "type": "SUB-EX24" }, { "created_time": 1632941870, "end_time": 1744156799, "id": "9b599b0f-1234-5678-90ab-406081b58e7f", "modified_time": 1632941870, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 10, "remaining_quantity": 10, "start_time": 1632873600, "subscription_id": "ENG-000000bd", "type": "SUB-ENG" }, { "created_time": 1632941882, "end_time": 1744156799, "id": "d6d8ead3-1234-5678-90ab-98badeac7287", "modified_time": 1632941882, "order_id": "00000000", "org_id": "9777c1a0-1234-5678-90ab-02e208b2d34f", "quantity": 11, "remaining_quantity": 9, "start_time": 1632873600, "subscription_id": "MAN-000008be", "type": "SUB-MAN" } ], "summary": { "SUB-ENG": 18, "SUB-EX24": 3, "SUB-MAN": 22, "SUB-VNA": 20 }}claimMspLicense POST
Claim a license order for this MSP by submitting the activation code from the order.
moveOrDeleteMspLicenseToAnotherOrg PUT
Perform an MSP license action, such as amending license quantity to an organization, deleting a subscription, undoing an amendment, or annotating a subscription.