SaaS API결제 및 예산
부족분 lock 조회
캠페인의 80% 부족분 lock 상태를 조회합니다.
부족분 lock 조회
캠페인의 80% 의무 기준에 대한 부족분 lock 상태와 정책 활성화 여부를 조회합니다.
기업 사용자(해당 캠페인 소유자)와 관리자 모두 사용 가능합니다.
개요
캠페인은 최초 입금액의 80% 이상을 사용해야 한다는 의무가 있습니다. 자연 사용량(크리에이터별 NORMAL lock)만으로 80%에 미치지 못할 때, 기업이 부족분만큼을 명시적으로 캠페인 예산 내에 lock할 수 있습니다. 본 API는 그 lock 상태를 조회합니다.
HTTP 요청
GET /ai/campaigns/{collabNo}/budget/deficit-lock
Authorization: Bearer {access_token}Path Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
collabNo | Integer | 예 | 캠페인 번호 |
응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "조회 완료",
"data": {
"engaged": true,
"amount": 300000,
"status": "LOCKED",
"threshold": 800000,
"sumLockedNormal": 500000,
"policyEnabled": true
}
}응답 필드 설명
| 필드 | 타입 | 설명 |
|---|---|---|
engaged | Boolean | 부족분 lock 가입 여부 (DEFICIT row 존재 여부) |
amount | Integer | 현재 lock된 부족분 금액. 미가입 시 0 |
status | String | LOCKED (활성 lock) / UNLOCKED (자연 사용 80% 충족) / null (미가입) |
threshold | Integer | 80% 기준 금액 (floor(최초입금 × 0.8)) |
sumLockedNormal | Integer | 현재 NORMAL lock 합계 (크리에이터별 reservation) |
policyEnabled | Boolean | 캠페인의 부족분 lock 정책 활성화 여부 |
상태 조합
| engaged | status | 의미 |
|---|---|---|
false | null | 기업이 아직 lock API를 호출하지 않음 |
true | LOCKED | 부족분이 존재하며 lock 중 |
true | UNLOCKED | 가입은 되어 있으나 자연 사용량이 80% 이상이라 lock 불필요 (자동 해제) |
에러 응답
| 상태 코드 | 설명 |
|---|---|
401 | 인증 실패 |
403 | 권한 없음 (해당 캠페인 소유자도 admin도 아님) |
404 | 캠페인을 찾을 수 없음 |
사용 예시
curl -X GET "https://api.glowb.com/ai/campaigns/12345/budget/deficit-lock" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"관련 API
참고 사항
- SaaS 시작 이전 캠페인(
collab.saas.num미만)은 본 기능을 사용할 수 없습니다. engaged=true인데status=UNLOCKED인 경우, NORMAL lock이 다시 80% 아래로 떨어지면 자동으로 LOCKED로 복귀합니다.