Skip to main content
프로모션 코드는 계정에 속하며, 하나의 상품으로 제한할 수 있고, 누가 몇 번까지, 언제까지 사용할 수 있는지와 할인이 몇 번의 청구 주기 동안 유지되는지를 제어합니다. Promo Codes API를 사용하면 계정의 코드를 생성하고, 목록을 조회하고 개별 코드를 조회하며, 코드를 비활성화하여 사용을 일시 중지하거나 다시 활성화하고, 더 이상 제공하지 않는 코드를 보관 처리할 수 있습니다.

엔드포인트

속성

string
필수
promo_ 접두사가 붙은 프로모션 코드 ID입니다.
object
필수
프로모션 코드를 소유한 계정입니다.

속성

string
필수
biz_ 접두사가 붙은 계정 ID입니다.
string
필수
계정 표시 이름입니다.
object | null
필수
프로모션 코드를 사용한 추천의 실적을 인정받는 제휴자이며, 연결된 제휴자가 없으면 null입니다.

속성

string
필수
aff_ 접두사가 붙은 제휴자 ID입니다.
object
필수
제휴자인 사용자입니다.

속성

string
필수
user_ 접두사가 붙은 제휴자 사용자 ID입니다.
string | null
필수
제휴자의 표시 이름입니다.
string
필수
제휴자 아바타 URL로, 아바타가 설정되지 않은 경우 생성된 대체 이미지를 포함합니다.
string | null
필수
제휴자의 공개 사용자 이름입니다.
number
필수
할인 금액입니다. 비율 할인은 소수 분수로 표현됩니다.
boolean
필수
프로모션 코드가 이탈한 고객으로 제한되는지 여부입니다.
string | null
필수
결제 시 입력하는 코드입니다.
string
필수
프로모션 코드가 생성된 시각으로, ISO 8601 타임스탬프입니다.
string
필수
정액 할인에 사용되는 통화입니다.사용 가능한 옵션: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau, hnl
string
필수
할인이 적용되는 기간입니다.사용 가능한 옵션: forever, once, repeating
boolean
필수
프로모션 코드가 기존 멤버십에만 적용되는지 여부입니다.
string | null
필수
프로모션 코드가 만료되는 시각으로, ISO 8601 타임스탬프입니다.
object
필수
프로모션 코드에 저장된 사용자 정의 키-값 메타데이터입니다.
boolean
필수
프로모션 코드가 신규 고객으로 제한되는지 여부입니다.
boolean
필수
각 고객이 프로모션 코드를 한 번만 사용할 수 있는지 여부입니다.
object | null
필수
프로모션 코드가 제한되는 상품이며, 상품 범위로 제한되지 않으면 null입니다.

속성

string
필수
prod_ 접두사가 붙은 상품 ID입니다.
string
필수
상품 표시 이름입니다.
integer | null
필수
할인이 적용되는 청구 주기 수입니다.
string
필수
할인이 비율 기반인지 정액인지 여부입니다.사용 가능한 옵션: percentage, flat_amount
string
필수
프로모션 코드의 수명 주기 상태입니다.사용 가능한 옵션: active, inactive, archived
integer
필수
재고가 제한된 경우 최대 사용 횟수입니다.
boolean
필수
프로모션 코드에 사용 한도가 없는지 여부입니다.
string
필수
프로모션 코드가 업데이트된 시각으로, ISO 8601 타임스탬프입니다.
integer
필수
프로모션 코드를 사용한 멤버십 수입니다.
PromoCode