@portone/server-sdk
    Preparing search index...

    Type Alias BillingKeyClient

    type BillingKeyClient = {
        getBillingKeyInfo: (
            options: { billingKey: string; storeId?: string },
        ) => Promise<BillingKeyInfo>;
        deleteBillingKey: (
            options: { billingKey: string; storeId?: string; reason?: string },
        ) => Promise<DeleteBillingKeyResponse>;
        getBillingKeyInfos: (
            options?: {
                page?: PageInput;
                sort?: BillingKeySortInput;
                filter?: BillingKeyFilterInput;
            },
        ) => Promise<GetBillingKeyInfosResponse>;
        issueBillingKey: (
            options: {
                storeId?: string;
                method: InstantBillingKeyPaymentMethodInput;
                channelKey?: string;
                channelGroupId?: string;
                customer?: CustomerInput;
                customData?: string;
                bypass?: object;
                noticeUrls?: string[];
            },
        ) => Promise<IssueBillingKeyResponse>;
    }
    Index

    Properties

    getBillingKeyInfo: (
        options: { billingKey: string; storeId?: string },
    ) => Promise<BillingKeyInfo>

    빌링키 단건 조회

    주어진 빌링키에 대응되는 빌링키 정보를 조회합니다.

    GetBillingKeyInfoError

    deleteBillingKey: (
        options: { billingKey: string; storeId?: string; reason?: string },
    ) => Promise<DeleteBillingKeyResponse>

    빌링키 삭제

    빌링키를 삭제합니다.

    DeleteBillingKeyError

    getBillingKeyInfos: (
        options?: {
            page?: PageInput;
            sort?: BillingKeySortInput;
            filter?: BillingKeyFilterInput;
        },
    ) => Promise<GetBillingKeyInfosResponse>

    빌링키 다건 조회

    주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다.

    GetBillingKeyInfosError

    issueBillingKey: (
        options: {
            storeId?: string;
            method: InstantBillingKeyPaymentMethodInput;
            channelKey?: string;
            channelGroupId?: string;
            customer?: CustomerInput;
            customData?: string;
            bypass?: object;
            noticeUrls?: string[];
        },
    ) => Promise<IssueBillingKeyResponse>

    빌링키 발급

    빌링키 발급을 요청합니다.

    IssueBillingKeyError