Update overage

Article
09/25/2024

Applies To

Partner Center

Appropriate roles

Admin agent

Note

The new commerce experiences for license-based services include many new capabilities and are available to all Cloud Solution Provider (CSPs). For more information, see new commerce experiences overview.

Used to set overage for a given customer to a consumption subscription. Can also be used to remove overage by setting it to false. Overage enables a customer to continue using services if they use the service beyond the stated limits. Overage defines the consumption subscription overage pay-as-you-go will accrue to.

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).
At least one eligible overage subscription purchased for the customer.

REST request

[PUT] /customers/{customer-tenant-id}/subscriptions/overage

Request syntax

Method	Request URI
PUT	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/overage HTTP/1.1

URI parameter

Use the following query parameters to return a customer's overage.

Name	Type	Required	Description
customer-tenant-id	guid	Y	A GUID corresponding to the customer's tenant.

Request headers

For more information, see Partner Center REST headers.

Request body

Name	Type	Description
azureEntitlementId	guid	A GUID defining the consumption subscription for overage.
partnerId	guid	The PartnerID of an Indirect Reseller. Only applicable for a two tier model (Indirect Provider).
overageEnabled	bool	Indicate whether overage should be enabled for a given consumption subscription.

Request example

PUT https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/overage HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

{
    "azureEntitlementId": "ea1c26b7-8c99-42bb-ba7d-c535831fae8e",
    "partnerId": "5357563",
    "overageEnabled": true
}

REST response

If successful, this method returns overage for a customer.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Error Codes.

Response example

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT

{
    "azureEntitlementId": "ea1c26b7-8c99-42bb-ba7d-c535831fae8e",
    "partnerId": "5357563",
    "type": "PhoneServices",
    "overageEnabled": true,
    "links": {
        "overage": {
            "uri": "/customers/f62cf10b-8f76-4fc4-9774-c5291f8faf86/subscriptions/overage",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Overage"
    }
}

Share via