API

플랜 구독

작성일 2026.03.14 | 수정일 2026.03.14

POST/cash/v1/subscribes

특정 플랜을 구독합니다. 구독 시 정산일을 설정해야 합니다.

Body Params

NameTypeRequiredDescription
planIdstring*구독할 플랜 ID (32자)
settlementDaystring*정산일 유형. 'LAST'(매월 말일) 또는 'CUSTOM'(지정일).
settlementCustomDatenumber정산 지정일 (1~31). settlementDay가 'CUSTOM'인 경우 필수.

Response

NameTypeRequiredDescription
subscribeIdstring*구독 고유 ID (32자, 'CA01SU' 접두사)
accountIdstring*계정 고유 ID
planIdstring*구독한 플랜 ID
statusstring*구독 상태. ACTIVE(활성), INACTIVE(비활성), NOT_PAID(미결제), DELETED(삭제됨).
settlementDaystring*정산일 유형. LAST(매월 말일) 또는 CUSTOM(지정일).
settlementCustomDatenumber|null*정산 지정일 (1~31). settlementDay가 CUSTOM인 경우에만 유효.
dateLastPaidstring*마지막 결제 일시 (ISO 8601)
dateCreatedstring*구독 생성 일시 (ISO 8601)
dateUpdatedstring*최종 수정 일시 (ISO 8601)

Structure

Request
{ "planId": "CA01PL01234567890123456789AB", "settlementDay": "CUSTOM", "settlementCustomDate": 15 }
Response
{ "subscribeId": "CA01SU01234567890123456789AB", "accountId": "12345678901234", "planId": "CA01PL01234567890123456789AB", "status": "ACTIVE", "settlementDay": "CUSTOM", "settlementCustomDate": 15, "dateLastPaid": "2024-07-01T12:00:00.000Z", "dateCreated": "2024-07-01T12:00:00.000Z", "dateUpdated": "2024-07-01T12:00:00.000Z" }