portone_server_sdk.BillingKeyClient

portone_server_sdk.BillingKeyClient#

class portone_server_sdk.BillingKeyClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters:

  • secret (str) – 포트원 API Secret입니다.

  • base_url (str, optional) – 포트원 REST API 주소입니다. 기본값은 `”https://api.portone.io”`입니다.

  • store_id – 하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

delete_billing_key(*, billing_key[, reason])

빌링키 삭제

delete_billing_key_async(*, billing_key[, ...])

빌링키 삭제

get_billing_key_info(*, billing_key)

빌링키 단건 조회

get_billing_key_info_async(*, billing_key)

빌링키 단건 조회

get_billing_key_infos(*[, page, sort, filter])

빌링키 다건 조회

get_billing_key_infos_async(*[, page, sort, ...])

빌링키 다건 조회

issue_billing_key(*, method[, channel_key, ...])

빌링키 발급

issue_billing_key_async(*, method[, ...])

빌링키 발급
get_billing_key_infos(*, page: PageInput | None = None, sort: BillingKeySortInput | None = None, filter: BillingKeyFilterInput | None = None) → GetBillingKeyInfosResponse#

빌링키 다건 조회

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

Parameters:

  • page (PageInput, optional) –

    요청할 페이지 정보

    미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

  • sort (BillingKeySortInput, optional) –

    정렬 조건

    미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.

  • filter (BillingKeyFilterInput, optional) –

    조회할 빌링키 조건 필터

    V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Raises:

  • GetBillingKeyInfosError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_billing_key_infos_async(*, page: PageInput | None = None, sort: BillingKeySortInput | None = None, filter: BillingKeyFilterInput | None = None) → GetBillingKeyInfosResponse#

빌링키 다건 조회

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

Parameters:

  • page (PageInput, optional) –

    요청할 페이지 정보

    미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

  • sort (BillingKeySortInput, optional) –

    정렬 조건

    미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.

  • filter (BillingKeyFilterInput, optional) –

    조회할 빌링키 조건 필터

    V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Raises:

  • GetBillingKeyInfosError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

issue_billing_key(*, method: InstantBillingKeyPaymentMethodInput, channel_key: str | None = None, channel_group_id: str | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, bypass: dict | None = None, notice_urls: list[str] | None = None) → IssueBillingKeyResponse#

빌링키 발급

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

Parameters:

  • method (InstantBillingKeyPaymentMethodInput) – 빌링키 결제 수단 정보

  • channel_key (str, optional) –

    채널 키

    채널 키 또는 채널 그룹 ID 필수

  • channel_group_id (str, optional) –

    채널 그룹 ID

    채널 키 또는 채널 그룹 ID 필수

  • customer (CustomerInput, optional) – 고객 정보

  • custom_data (str, optional) – 사용자 지정 데이터

  • bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

  • notice_urls (list[str], optional) –

    웹훅 주소

    빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

Raises:

  • IssueBillingKeyError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async issue_billing_key_async(*, method: InstantBillingKeyPaymentMethodInput, channel_key: str | None = None, channel_group_id: str | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, bypass: dict | None = None, notice_urls: list[str] | None = None) → IssueBillingKeyResponse#

빌링키 발급

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

Parameters:

  • method (InstantBillingKeyPaymentMethodInput) – 빌링키 결제 수단 정보

  • channel_key (str, optional) –

    채널 키

    채널 키 또는 채널 그룹 ID 필수

  • channel_group_id (str, optional) –

    채널 그룹 ID

    채널 키 또는 채널 그룹 ID 필수

  • customer (CustomerInput, optional) – 고객 정보

  • custom_data (str, optional) – 사용자 지정 데이터

  • bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

  • notice_urls (list[str], optional) –

    웹훅 주소

    빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

Raises:

  • IssueBillingKeyError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_billing_key_info(*, billing_key: str) → DeletedBillingKeyInfo | IssuedBillingKeyInfo | dict#

빌링키 단건 조회

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

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

  • GetBillingKeyInfoError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_billing_key_info_async(*, billing_key: str) → DeletedBillingKeyInfo | IssuedBillingKeyInfo | dict#

빌링키 단건 조회

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

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

  • GetBillingKeyInfoError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

delete_billing_key(*, billing_key: str, reason: str | None = None) → DeleteBillingKeyResponse#

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

  • billing_key (str) – 삭제할 빌링키

  • reason (str, optional) –

    사유

    네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.

Raises:

  • DeleteBillingKeyError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async delete_billing_key_async(*, billing_key: str, reason: str | None = None) → DeleteBillingKeyResponse#

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

  • billing_key (str) – 삭제할 빌링키

  • reason (str, optional) –

    사유

    네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.

Raises:

  • DeleteBillingKeyError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우