사용자의 구독 청구 상태 변경
Microsoft Store 구매 API에서 이 메서드를 사용하여 지정된 사용자의 구독 추가 기능 청구 상태를 변경할 수 있습니다. 구독에 대한 자동 갱신을 취소, 연장, 환불 또는 비활성화할 수 있습니다.
참고 항목
이 메서드는 UWP(유니버설 Windows 플랫폼) 앱에 대한 구독 추가 기능을 만들 수 있도록 Microsoft가 프로비전한 개발자 계정에서만 사용할 수 있습니다. 구독 추가 기능은 현재 대부분의 개발자 계정에서 사용할 수 없습니다.
Microsoft.StoreServices 라이브러리는 이 메서드의 기능을 StoreServicesClient.RecurrenceChangeAysnc API를 통해 제공합니다.
필수 조건
이 메서드를 사용하려면 다음이 필요합니다.
- 대상 URI 값이
https://onestore.microsoft.com인 Azure AD 액세스 토큰. - 변경할 구독에 대한 권한을 갖고 있는 사용자의 ID를 나타내는 Microsoft Store ID 키.
자세한 정보는 서비스에서 제품 권리 유형 관리하기를 참조하세요.
요청
요청 구문
| 메서드 | 요청 URI |
|---|---|
| 게시 | https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/{recurrenceId}/change |
요청 헤더
| 헤더 | 형식 | 설명 |
|---|---|---|
| 권한 부여 | string | 필수. Bearer<토큰> 형식의 Azure AD 액세스 토큰. |
| Host | 문자열 | purchase.mp.microsoft.com 값으로 설정해야 합니다. |
| Content-Length | 수 | 요청 본문의 길이입니다. |
| Content-Type | 문자열 | 요청 및 응답 형식을 지정합니다. 현재 유일하게 지원되는 값은 application/json입니다. |
요청 매개 변수
| 속성 | 형식 | 설명 | 필수 |
|---|---|---|---|
| recurrenceId | string | 변경하려는 구독의 ID입니다. 이 ID를 가져오려면 get subscriptions for a user 메서드를 호출하고, 변경하려는 구독 추가 기능을 나타내는 응답 본문 항목을 확인하고, 해당 항목의 id 필드 값을 사용합니다. | 예 |
요청 본문
| 필드 | 형식 | 설명 | 필수 |
|---|---|---|---|
| b2bKey | string | 구독을 변경할 사용자의 ID를 나타내는 Microsoft Store ID 키입니다. | 예 |
| changeType | string | 수행하려는 변경 유형을 식별하는 다음 문자열 중 하나입니다.
|
예 |
| extensionTimeInDays | string | changeType 매개 변수 값이 연장이면 이 매개 변수는 구독을 연장하는 일 수를 지정합니다. | changeType의 값이 연장이면 예, 그렇지 않으면 아니요입니다. |
요청 예제
다음 예제는 이 메서드를 사용하여 구독 기간을 5일 연장하는 방법을 보여 줍니다. b2bKey 값을 변경할 구독의 사용자 ID를 나타내는 Microsoft Store ID 키로 바꿉니다.
POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac/change HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
Host: https://purchase.mp.microsoft.com
{
"b2bKey": "eyJ0eXAiOiJ...",
"changeType": "Extend",
"extensionTimeInDays": "5"
}
응답
이 메서드는 수정된 필드를 포함하여 수정된 구독 추가 기능에 대한 정보가 포함된 JSON 응답 본문을 반환합니다. 다음 예제에서는 이 메서드의 응답 본문을 보여 줍니다.
{
"items": [
{
"autoRenew":true,
"beneficiary":"pub:gFVuEBiZHPXonkYvtdOi+tLE2h4g2Ss0ZId0RQOwzDg=",
"expirationTime":"2017-06-16T03:07:49.2552941+00:00",
"id":"mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac",
"lastModified":"2017-01-10T21:08:13.1459644+00:00",
"market":"US",
"productId":"9NBLGGH52Q8X",
"skuId":"0024",
"startTime":"2017-01-10T21:07:49.2552941+00:00",
"recurrenceState":"Active"
}
]
}
응답 본문
응답 본문에는 다음의 데이터가 포함됩니다.
| 값 | 형식 | 설명 |
|---|---|---|
| autoRenew | Boolean | 현재 구독 기간이 종료되면 구독을 자동으로 갱신할 것인지 여부를 나타냅니다. |
| beneficiary | 문자열 | 이 구독과 연결된 권한의 수취인 ID입니다. |
| expirationTime | 문자열 | 구독이 만료되는 날짜 및 시간이며, ISO 8601 형식입니다. 이 필드는 구독이 특정 상태일 때만 사용할 수 있습니다. 만료 시간은 일반적으로 현재 상태가 만료되는 시간을 나타냅니다. 예를 들어 활성 구독의 경우 만료 날짜는 다음 자동 갱신이 이루어지는 시간을 나타냅니다. |
| expirationTimeWithGrace | 문자열 | 유예 기간을 포함하는 구독이 만료되는 날짜 및 시간이며, ISO 8601 형식입니다. 이 값은 구독이 자동으로 갱신되지 않은 후 사용자가 구독에 액세스할 수 없게 될 때를 나타냅니다. |
| id | 문자열 | 구독의 ID입니다. 이 값을 사용하여 change the billing state of a subscription for a user 메서드를 호출할 때 수정할 구독을 나타냅니다. |
| isTrial | Boolean | 구독이 평가판인지 여부를 나타냅니다. |
| lastModified | 문자열 | 구독이 마지막으로 수정된 날짜 및 시간이며, ISO 8601 형식입니다. |
| 시장 | 문자열 | 사용자가 구독을 획득한 국가 번호입니다(두 문자로 된 ISO 3166-1 alpha-2 형식). |
| productId | 문자열 | Microsoft Store 카탈로그에서 구독 추가 기능을 나타내는 제품의 Store ID. 예를 들어 제품에 대한 Microsoft Store ID는 9NBLGGH42CFD입니다. |
| skuId | 문자열 | Microsoft Store 카탈로그에서 구독 추가 기능을 나타내는 SKU의 Store ID. SKU에 대한 Microsoft Store ID의 예시로는 0010이 있습니다. |
| startTime | 문자열 | 구독의 시작 날짜 및 시간이며, ISO 8601 형식입니다. |
| recurrenceState | 문자열 | 다음의 값 중 하나입니다.
참고:
|
| cancellationDate | 문자열 | 사용자의 구독이 취소된 날짜 및 시간이며, ISO 8601 형식입니다. |