구매 한도 설정 | Bootpay 커머스 매뉴얼

고객 그룹의 주간/월간 구매 한도를 설정해요. 기업 고객의 예산 관리나 구매 통제가 필요한 경우 활용해요.

API 엔드포인트

PUThttps://api.bootapi.com/v1/user-groups/:user_group_id/limitBasic Auth

요청 파라미터

파라미터	타입	필수	설명
`user_group_id`	String	필수	그룹 고유 ID (URL 파라미터)
`use_limit`	Boolean	선택	구매 한도 기능 사용 여부
`limit_month_purchase`	Number	선택	월 구매 한도 금액 (단위: 원)
`limit_week_purchase`	Number	선택	주 구매 한도 금액 (단위: 원)

코드 예제

const { BootpayCommerce } = require('@bootpay/backend-js');

const commerce = new BootpayCommerce({
    client_key: '{client_key}',
    secret_key: '{secret_key}'
});

const userGroupId = '67e2052b03d0cb4e4117b0af';
const response = await commerce.userGroup.limit(userGroupId, {
    use_limit: true,
    limit_month_purchase: 3500000,
    limit_week_purchase: 1000000
});
console.log(response);javascript

from bootpay_backend.commerce import BootpayCommerce

commerce = BootpayCommerce('{client_key}', '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.user_group.limit(user_group_id, {
    'use_limit': True,
    'limit_month_purchase': 3500000,
    'limit_week_purchase': 1000000
})
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
$userGroupId = '67e2052b03d0cb4e4117b0af';
$response = $commerce->userGroup->limit($userGroupId, [
    'use_limit' => true,
    'limit_month_purchase' => 3500000,
    'limit_week_purchase' => 1000000
]);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
import kr.co.bootpay.store.model.request.userGroup.UserGroupLimitParams;

TokenPayload tokenPayload = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore bootpay = new BootpayStore(tokenPayload);
UserGroupLimitParams params = new UserGroupLimitParams();
params.userGroupId = "67e2052b03d0cb4e4117b0af";
params.useLimit = true;
params.limitMonthPurchase = 3500000.0;
params.limitWeekPurchase = 1000000.0;

var response = bootpay.asManager().userGroup.limit(params);
System.out.println(response.getData());java

commerce = BootpayStore::Api.new('{client_key}', '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.user_group.limit(user_group_id, {
    use_limit: true,
    limit_month_purchase: 3500000,
    limit_week_purchase: 1000000
})
puts responseruby

commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
userGroupId := "67e2052b03d0cb4e4117b0af"
response, err := commerce.UserGroup.Limit(userGroupId, map[string]interface{}{
    "use_limit":            true,
    "limit_month_purchase": 3500000,
    "limit_week_purchase":  1000000,
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var userGroupId = "67e2052b03d0cb4e4117b0af";
var response = await commerce.UserGroup.Limit(userGroupId, new {
    use_limit = true,
    limit_month_purchase = 3500000,
    limit_week_purchase = 1000000
});
Console.WriteLine(response);csharp

응답

성공 응답

{
  "use_limit": true,
  "limit_month_purchase": 3500000,
  "limit_week_purchase": 1000000,
  "subscribed_month_limit": 1200000,
  "subscribed_week_limit": 300000
}json

subscribed_month_limit과 subscribed_week_limit은 현재까지의 구독 사용량을 나타내요. 한도 대비 사용량을 비교하여 남은 한도를 계산할 수 있어요.

에러 코드

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

코드	메시지	대처 방법
`USER_GROUP_NOT_FOUND`	회원 그룹 정보를 찾지 못했어요. 다시 로그인해요.	user_group_id를 확인해요
`USER_GROUP_SUBSCRIPTION_PURCHASE_LIMIT_ERROR`	월 구매 한도 금액이 초과했어요.	구매 한도를 확인하거나 관리자에게 상향 요청해요
`USER_GROUP_PURCHASE_LIMIT_REQUIRED`	월 구매 한도 금액 값을 입력해요.	purchase_limit 값을 입력해요
`USER_GROUP_PURCHASE_LIMIT_BELOW_SUBSCRIBED`	월 구매 한도 금액이 현재 구독된 금액보다 적어요.	현재 구독 금액 이상으로 설정해요