Skip to content

createBillingFlow — @gj-kit/toss-payments

A public function from @gj-kit/toss-payments/server. The signature below is taken directly from the 0.6.1 release declaration.

import { createBillingFlow } from '@gj-kit/toss-payments/server';
/**
* 빌링 플로우 팩토리 — client는 'api' KeyKind 전용(위젯 키 클라이언트는 컴파일 에러),
* store는 필수(조회 API가 없어 저장이 유일한 보관 수단).
*/
declare function createBillingFlow<E extends Env, C extends BillingCapabilities = {}>(client: TossServerClient<E, 'api'>, store: BillingKeyStore, options?: {
readonly capabilities?: C;
/**
* §3.3 이벤트 버스 — billing.issued/approved/approve-failed/revoked 발행 지점.
* payload에 billingKey는 원천 부재(봉인 원칙 유지). createTossEvents 산출물만 발행이 흐른다.
*/
readonly events?: TossEvents;
}): BillingFlow<E, C>;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/toss-payments
  • Version: 0.6.1
  • Public entry: ./server
  • Source: GitHub