> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Renewing a User Store ID key

> Renew a User Store ID key in Microsoft Store services before its 30-day lifetime expires, so your backend can continue authenticating calls.

This article describes how to renew a User Store ID key.

When you [generate a User Store ID key](/publishing/xstore-commerce/xstore-requesting-userstoreid#step-4-create-a-user-store-id-key), it has a lifetime of 30 days. Within that period, the key can authenticate calls to Microsoft Store services. You can renew it before expiration to generate a new key for the same Microsoft Entra app client ID and user identity.

## Prerequisites

To renew a User Store ID key, you need the following keys/tokens:

* A Microsoft Entra ID access token that has the audience URI value `https://onestore.microsoft.com`
* An expired Microsoft Store ID key that was [generated from client-side code in your app](/publishing/xstore-commerce/xstore-requesting-userstoreid#step-4-create-a-user-store-id-key).

For more information, see [Requesting a User Store ID for service-to-service authentication](/publishing/xstore-commerce/xstore-requesting-userstoreid).

## Request

### Request syntax

| Key type      | Method | Request URI                                                |
| ------------- | ------ | ---------------------------------------------------------- |
| `Collections` | `POST` | `https://collections.mp.microsoft.com/v6.0/b2b/keys/renew` |
| `Purchase`    | `POST` | `https://purchase.mp.microsoft.com/v6.0/b2b/keys/renew`    |

### Request header

| Header           | Type     | Description                                                                                         |
| ---------------- | -------- | --------------------------------------------------------------------------------------------------- |
| `Host`           | `string` | Must be set to the value `collections.mp.microsoft.com` or `purchase.mp.microsoft.com`.             |
| `Content-Length` | `number` | The length of the request body.                                                                     |
| `Content-Type`   | `string` | Specifies the request and response type. Currently, the only supported value is `application/json`. |

### Request body

| Parameter       | Type     | Description                              | Required |
| --------------- | -------- | ---------------------------------------- | -------- |
| `serviceTicket` | `string` | Microsoft Entra ID service access token. | Yes      |
| `key`           | `string` | Expired Microsoft Store ID key.          | Yes      |

### Request example

```syntax theme={null}
POST https://collections.mp.microsoft.com/v6.0/b2b/keys/renew HTTP/1.1
Content-Length: 2774
Content-Type: application/json
Host: collections.mp.microsoft.com

{
    "serviceTicket": "eyJ0eXAiOiJKV1QiLCJhb...",
    "Key": "eyJ0eXAiOiJKV1QiLCJhbG..."
}
```

## Response

### Response body

| Parameter | Type     | Description                                                                                                             |
| --------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| `key`     | `string` | The refreshed User Store ID key that can be used in future calls to the Microsoft Store collections API or purchase API |

### Response example

```syntax theme={null}
HTTP/1.1 200 OK
Content-Length: 1646
Content-Type: application/json
MS-CorrelationId: bfebe80c-ff89-4c4b-8897-67b45b916e47
MS-RequestId: 1b5fa630-d672-4971-b2c0-3713f4ea6c85
MS-CV: xu2HW6SrSkyHyFh.0.0
MS-ServerId: 030011428
Date: Tue, 13 Sep 2019 07:31:12 GMT

{
    "key":"eyJ0eXAi..."
}
```

## Error codes

| Code | Error        | Inner error code             | Description                                                                                                                                               |
| ---- | ------------ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 401  | Unauthorized | `AuthenticationTokenInvalid` | The Microsoft Entra ID access token is invalid. In some cases, `ServiceError` includes more details, such as token expiration or a missing `appid` claim. |
| 401  | Unauthorized | `InconsistentClientId`       | The `clientId` claim in the User Store ID key and the `appid` claim in the Microsoft Entra ID access token don't match.                                   |

## Reference API documentation

* [XStore (API contents)](/reference/system/xstore/xstore_members)

## See also

[Commerce (overview)](/publishing/xstore-commerce/xstore-commerce-overview)

[Manage products from your services](/publishing/xstore-commerce/xstore-authenticating-service)

[Requesting a User Store ID for service-to-service authentication](/publishing/xstore-commerce/xstore-requesting-userstoreid)

[Requesting a User Store ID from your service with X-tokens or OAuth 2.0](/publishing/xstore-commerce/xstore-requesting-userstoreid-oauth)

[Authenticating your service with the Microsoft Store APIs](/publishing/xstore-commerce/xstore-authenticating-service)

[Microsoft.StoreServices library (GitHub)](https://github.com/microsoft/Microsoft-Store-Services)

[Microsoft.StoreServices sample (GitHub)](https://github.com/microsoft/Microsoft-Store-Services-Sample)

[XStore (API reference)](/reference/system/xstore/xstore_members)


## Related topics

- [Request a User Store ID for service-to-service auth](/publishing/xstore-commerce/xstore-requesting-userstoreid.md)
- [Authenticating your service with the Microsoft Store APIs](/publishing/xstore-commerce/xstore-authenticating-service.md)
- [Request a User Store ID with X-tokens or OAuth 2.0](/publishing/xstore-commerce/xstore-requesting-userstoreid-oauth.md)
- [Microsoft Store v8 Collections b2bLicensePreview API](/reference/microsoft-store-apis/xstore-v8-query-for-products.md)
- [XStoreGetUserPurchaseIdAsync](/reference/system/xstore/functions/xstoregetuserpurchaseidasync.md)