구독

조정 전체 변경

회차 조정 항목을 통째로 갈아끼워 가격 정책을 다시 맞춰요.

구독 계약의 회차 금액 조정 항목을 한번에 변경하는 API예요. 요청한 항목으로 기존 내용을 모두 대체​​해요.

API 엔드포인트

PUThttps://api.bootapi.com/v1/order_subscriptions/:id/adjustmentsBearer Token (supervisor)
관리자 권한 필요

이 API는 supervisor 권한이 필요해요. 관리자 토큰으로 요청해요.

전체 대체 방식

기존 조정 항목이 모두 삭제​​되고 요청한 항목으로 대체돼요. 수정이 아닌 전체 교체예요. 특정 항목만 삭제하려면 조정 항목 삭제를 사용해요.

요청 파라미터

파라미터 타입 필수 설명
order_subscription_id String 필수 구독 계약 고유 번호 (URL 파라미터)
adjustments Array 필수 대체할 조정 항목 배열
adjustments[].name String 필수 조정 항목명
adjustments[].price Integer 필수 조정 금액
adjustments[].tax_free_price Integer 선택 면세 금액
adjustments[].type Integer 필수 조정 타입
adjustments[].duration Integer 선택 적용 회차

코드 예제

curl -X PUT "https://api.bootapi.com/v1/order_subscriptions/{order_subscription_id}/adjustments" \
  -H "Authorization: Basic {base64(client_key:secret_key)}" \
  -H "Content-Type: application/json" \
  -d '{
    "adjustments": [
      {
        "name": "설치비",
        "price": 50000,
        "type": 2
      },
      {
        "name": "프로모션 할인",
        "price": -10000,
        "type": 0,
        "duration": 1
      }
    ]
  }'bash

응답

성공 응답

{
  "order_subscription_id": "687a1b2c3d4e5f6789012345",
  "order_subscription_adjustments": [
    {
      "id": "adj_001",
      "name": "설치비",
      "price": 50000,
      "type": 2
    },
    {
      "id": "adj_002",
      "name": "프로모션 할인",
      "price": -10000,
      "type": 0,
      "duration": 1
    }
  ]
}json

응답 파라미터

파라미터 타입 설명
order_subscription_id String 구독 계약 ID
order_subscription_adjustments Array 변경된 전체 조정 항목 목록

에러 코드

공통 에러

인증·권한 관련 에러는 에러 코드표를 참고해요.

코드 메시지 대처 방법
SUBSCRIPTION_ADJUSTMENT_NOT_FOUND 구독결제 조정 정보를 찾을 수 없어요. adjustment_id를 확인해요
SUBSCRIPTION_ADJUSTMENT_PAYMENT_COMPLETED 이미 결제가 완료된 회차예요. 가격조정을 할 수 없어요. 미결제 회차에 대해서만 조정해요
SUBSCRIPTION_ADJUSTMENT_DURATION_INVALID 회차가 지정되지 않았어요. 조정할 회차를 지정해요. cycle 파라미터를 입력해요