구독 수정
PUT /accounts/{account_id}/core/v1/subscriptions/{subscription_id}
저장된 리소스 전체를 제공된 JSON 요청 본문으로 교체하되, 사용자가 수정할 수 없는 키 값은 유지합니다.
부작용
-
사용자가 구독을 취소하는 경우 PUT 엔드포인트는 "status": "inactive"로 호출되어야 합니다.
-
상태가 "inactive"로 설정되면 이 구독에 대한 보류 중인 요금이 Zuora로 전송되고 Zuora 구독은 어떤 방식으로든 "inactive"로 표시됩니다.
매개변수
| 이름 | 유형 | 에서 | 필수 요소입니다 | 설명 |
|---|---|---|---|---|
account_id |
문자열 |
경로 |
참 |
포함하는 계정 리소스의 ID
|
subscription_id |
문자열 |
경로 |
참 |
나열할 구독 컬렉션의 ID |
요청 본문
저장된 리소스 전체를 제공된 JSON 요청 본문으로 교체하되, 사용자가 수정할 수 없는 키 값은 유지합니다.
부작용
-
사용자가 구독을 취소하는 경우 PUT 엔드포인트는 "status": "inactive"로 호출되어야 합니다.
-
상태가 "inactive"로 설정되면 이 구독에 대한 보류 중인 요금이 Zuora로 전송되고 Zuora 구독은 어떤 방식으로든 "inactive"로 표시됩니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.
|
버전 |
문자열 |
참 |
리소스 버전입니다. 정의된 값은 다음과 같습니다.
|
ID입니다 |
문자열 |
거짓 |
리소스의 전역 고유 식별자입니다. 정의된 값은 다음과 같습니다.
|
고객 프로필 ID |
문자열 |
거짓 |
http://authorize.net["Authorize.net"]에서 UI에 의해 호출된 고객 프로필 ID가 포함된 JSON 문자열이 체험 기간에 대해 설정되지 않았습니다. 설정되지 않은 경우 읽기 작업 중에 빈 문자열을 반환합니다. 정의된 값은 다음과 같습니다.
|
paymentFirstName |
문자열 |
거짓 |
결제 청구에 사용되는 사용자 지정 긴 형식의 이름이 포함된 JSON 문자열입니다. 구독이 재청구될 때만 지정됩니다. 정의된 값은 다음과 같습니다.
|
paymentLastName |
문자열 |
거짓 |
결제 청구에 사용되는 사용자 지정 긴 형식의 성을 포함하는 JSON 문자열입니다. 구독이 재청구될 때만 지정됩니다. 정의된 값은 다음과 같습니다.
|
paymentAddress |
거짓 |
청구 주소를 지정하는 JSON 문자열 모음을 포함하는 JSON 객체입니다. 구독이 재청구될 때만 지정됩니다. 이 키가 존재하면 포함된 6개의 JSON 문자열이 모두 표시됩니다. 사용자가 아무것도 제공하지 않으면 문자열은 비어 있습니다. |
|
paymentProfileID |
문자열 |
거짓 |
UI에서 호출된 "Authorize.net"의 결제 프로필 ID를 포함하는 JSON 문자열입니다. 체험 기간에는 설정되지 않습니다. 설정되지 않은 경우 읽기 작업 중에 빈 문자열을 반환합니다. 정의된 값은 다음과 같습니다.
|
paymentExpiry |
문자열 |
거짓 |
결제 수단 만료 시점을 나타내는 타임스탬프가 포함된 JSON 문자열입니다. 이 값은 authorize.net에서 가져오며(http://authorize.net UI에서 설정됩니다. 정의된 값은 다음과 같습니다.
|
purchaseOrderNumber |
문자열 |
거짓 |
결제 방식에 대한 구매 주문 번호가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
마켓플레이스 |
문자열 |
거짓 |
결제 내역이 기록될 계정의 마켓플레이스를 나타내는 JSON 문자열입니다. 정의된 값:
|
licenseSN |
문자열 |
거짓 |
결제 수단에 대한 라이선스 일련 번호가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
약관 |
문자열 |
거짓 |
계정의 현재 등급을 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
상태 |
문자열 |
거짓 |
구독의 현재 상태를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
appLimit |
숫자 |
거짓 |
이 구독에 대한 애플리케이션 제한을 나타내는 JSON 숫자입니다. 값이 -1이면 제한이 없음을 의미합니다. |
namespaceLimit |
숫자 |
거짓 |
이 구독에 대한 네임스페이스 제한을 나타내는 JSON 숫자입니다. 값이 -1이면 제한이 없음을 의미합니다. |
subscriptionPeriod |
숫자 |
거짓 |
구독 기간을 나타내는 JSON 숫자입니다. -1 값은 제한이 없음을 의미합니다. 단위: 일 |
gracePeriod |
숫자 |
거짓 |
체험 구독이 만료되거나 유료 구독이 취소된 후 유예 기간을 나타내는 JSON 숫자입니다. 단위: 일 |
reminderBeforePeriod |
숫자 |
거짓 |
JSON 형식의 숫자로, 체험 구독 종료 전 고객 알림이 시작되는 시점까지의 일수를 나타냅니다. 값은 일 단위로 표시되며, -1은 해당되지 않음을 의미합니다. |
onboardStatus |
문자열 |
거짓 |
고객 온보딩의 현재 상태를 나타내는 JSON 문자열입니다. 유효한 값은 "not started", "in progress", "success", "failed"입니다. 정의된 값은 다음과 같습니다.
|
costPerAppUnit |
숫자 |
거짓 |
앱 단위당 비용을 나타내는 JSON 형식의 숫자입니다. 체험판의 경우 값은 0입니다. 단위: 미국 달러 |
costPerNamespaceUnit |
숫자 |
거짓 |
네임스페이스 단위당 비용을 나타내는 JSON 숫자입니다. 평가판의 경우 값은 0입니다. 단위: 미국 달러 |
메타데이터 |
거짓 |
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
|
요청 예시
{
"type": "application/astra-subscription",
"version": "1.2",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-05-01T00:00:00Z"
}
응답
Status: 204, Indicates if the subscription resource was updated.
응답
Status: 401, Unauthorized
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
응답
Status: 400, Bad request
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
|
invalidFields |
배열["invalidFields"] |
거짓 |
유효하지 않은 요청 본문 필드 목록 |
응답 예
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
응답
Status: 409, Conflict
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
|
invalidFields |
배열["invalidFields"] |
거짓 |
유효하지 않은 요청 본문 필드 목록 |
응답 예
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
응답
Status: 403, Forbidden
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
오류
Status: 404, Not found
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
예시 오류 응답
{
"type": "https://astra.netapp.io/problems/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
정의
정의를 참조하세요
paymentAddress
청구 주소를 지정하는 JSON 문자열 모음을 포함하는 JSON 객체입니다. 구독이 재청구될 때만 지정됩니다. 이 키가 존재하면 포함된 6개의 JSON 문자열이 모두 표시됩니다. 사용자가 아무것도 제공하지 않으면 문자열은 비어 있습니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
addressCountry |
문자열 |
참 |
ISO 3166 Alpha-2에 명시된 대로 우편 주소와 관련된 국가명 또는 국가 코드를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
addressLocality |
문자열 |
참 |
우편 주소와 관련된 지역(예: 도시) 정보를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
addressRegion |
문자열 |
참 |
우편 주소와 관련된 지역(예: 주)을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
postalCode |
문자열 |
참 |
우편 주소와 연결된 우편번호를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
streetAddress1 |
문자열 |
참 |
우편 주소와 연결된 도로명 주소를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
streetAddress2 |
문자열 |
거짓 |
선택적 부가 주소 정보, 우편 사서함 등을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
type_astra_label
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
|
값 |
문자열 |
참 |
type_astra_메타데이터_업데이트
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
-
Astra 메타데이터 스키마를 준수합니다. 생성 시 지정하지 않으면 레이블 없이 메타데이터 객체가 생성됩니다. 업데이트 시 지정하지 않으면 메타데이터 객체의 레이블인 creationTimestamp와 createdBy는 수정 없이 유지됩니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
라벨 |
거짓 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
거짓 |
|
modificationTimestamp |
문자열 |
거짓 |
|
생성 시 |
문자열 |
거짓 |
|
modifiedBy |
문자열 |
거짓 |
invalidParams
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
잘못된 쿼리 매개변수의 이름 |
이유 |
문자열 |
참 |
쿼리 매개변수가 유효하지 않은 이유 |
invalidFields
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
유효하지 않은 요청 본문 필드의 이름 |
이유 |
문자열 |
참 |
요청 본문 필드가 유효하지 않은 이유 |