xdata-kr Billing Plans API
The Billing Plans API from xdata-kr — 3 operation(s) for billing plans.
The Billing Plans API from xdata-kr — 3 operation(s) for billing plans.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/xdata-kr:xdata-kr-billing-plans-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: XBOSS Billing Plans API
description: '통합 REST API 서버 (홈택스 등). Human API guide: https://developer.xdata.kr · OpenAPI Reference: /docs'
version: 2.0.0
security:
- basicClientCredential: []
- mcpOAuth2: []
tags:
- name: Billing Plans
paths:
/v1/plans:
get:
tags:
- Billing Plans
summary: List Plans
description: 요금제 목록 조회.
operationId: list_plans_v1_plans_get
parameters:
- name: query
in: query
required: true
schema:
$ref: '#/components/schemas/PlanListQuery'
- name: env_scope
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: Env Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
- name: Authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: X-Env-Scope
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: X-Env-Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PageEnvelope_PlanResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/plans/{plan_id}:
get:
tags:
- Billing Plans
summary: Get Plan
description: 요금제 상세 조회.
operationId: get_plan_v1_plans__plan_id__get
parameters:
- name: plan_id
in: path
required: true
schema:
type: integer
title: Plan Id
- name: env_scope
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: Env Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
- name: Authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: X-Env-Scope
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: X-Env-Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlanResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/plans/{plan_id}/catalog-offer:
get:
tags:
- Billing Plans
summary: Get Plan Catalog Offer
description: Hybrid subscribe catalog snapshot.
operationId: get_plan_catalog_offer_v1_plans__plan_id__catalog_offer_get
parameters:
- name: plan_id
in: path
required: true
schema:
type: integer
title: Plan Id
- name: exclude_owned_subscription_id
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 1
- type: 'null'
description: When set, omit ACTIVE subscription_items product_ids from addon_offers (midlife Path B catalog; custom-plan W0 G2). Subscription must be ACTIVE and plan_id must match this catalog plan_id.
title: Exclude Owned Subscription Id
description: When set, omit ACTIVE subscription_items product_ids from addon_offers (midlife Path B catalog; custom-plan W0 G2). Subscription must be ACTIVE and plan_id must match this catalog plan_id.
- name: env_scope
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: Env Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
- name: Authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: X-Env-Scope
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
enum:
- production
- real_test
- sandbox
title: X-Env-Scope
description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlanCatalogOfferResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
PlanCatalogUsageUnitPriceItem:
properties:
data_provider:
type: string
maxLength: 64
minLength: 1
title: Data Provider
action:
type: string
maxLength: 128
minLength: 1
title: Action
unit_amount_minor:
type: integer
exclusiveMinimum: 0.0
title: Unit Amount Minor
currency:
type: string
maxLength: 3
minLength: 3
title: Currency
additionalProperties: false
type: object
required:
- data_provider
- action
- unit_amount_minor
- currency
title: PlanCatalogUsageUnitPriceItem
description: Metered unit price overlay for Console catalog-offer (read-only).
PageEnvelope_PlanResponse_:
properties:
items:
items:
$ref: '#/components/schemas/PlanResponse'
type: array
title: Items
description: Page result items. Empty list allowed.
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
description: Opaque cursor for next page, or null on last page.
has_more:
type: boolean
title: Has More
description: Whether another page exists. False when next_cursor is null.
default: false
additionalProperties: false
type: object
title: PageEnvelope[PlanResponse]
PlanResponse:
properties:
plan_id:
type: integer
minimum: 1.0
title: Plan Id
description: plans.id (BIGSERIAL PK).
code:
type: string
maxLength: 64
minLength: 1
title: Code
description: 비즈 식별 코드. 환경 내 유니크 (SCHEMA uq_plans_code_env_active).
name:
type: string
maxLength: 200
minLength: 1
title: Name
description: 사용자 노출 명칭.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: 요금제 설명 (마크다운 허용).
tier:
type: string
enum:
- FREE
- PAID
title: Tier
description: 요금제 등급. FREE/PAID.
billing_cycle:
type: string
enum:
- ONCE
- MONTHLY
- YEARLY
title: Billing Cycle
description: 청구 주기. ONCE/MONTHLY/YEARLY.
price:
$ref: '#/components/schemas/MoneyMinor'
description: 1회 청구 금액 (minor unit + 통화 + 부가세 포함 여부).
status:
type: string
enum:
- DRAFT
- ACTIVE
- DEPRECATED
- RETIRED
title: Status
description: 요금제 상태.
env_scope:
type: string
enum:
- sandbox
- real_test
- production
title: Env Scope
description: 환경 스코프.
created_at:
type: string
format: date-time
title: Created At
description: 발행 시각 (TIMESTAMPTZ, ISO 8601 + offset 포함; naive 입력 시 422).
addon_select_min:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Addon Select Min
description: 'W6/G7: min Path B pack count at subscribe (NULL=unlimited).'
addon_select_max:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Addon Select Max
description: 'W6/G7: max Path B pack count (NULL=unlimited).'
audience:
type: string
enum:
- standard
- integrator
title: Audience
description: 기본값 standard · 연동사 요금제는 integrator.
default: standard
max_active_account_links:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Max Active Account Links
description: 연동사 요금제의 좌석 상한 - 한 desktop_agent 클라이언트가 가질 수 있는 ACTIVE account_links 최대 수. audience='integrator' 일 때만 뜻이 있고 NULL 은 제한 없음(또는 해당 없음)이다.
included_usage_free_units:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Included Usage Free Units
description: 요금제 전체의 종량 무료 허용량(한 청구 기간 기준) - (sum of all data_provider/action usage_records quantity, not per action). NULL or 0 = no free allowance (billed from unit 1, current behavior).
website_visible:
anyOf:
- type: boolean
- type: 'null'
title: Website Visible
description: 판매 중일 때 공개 요금표에 노출할지 여부.
monthly_equivalent_amount_minor:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Monthly Equivalent Amount Minor
description: 연간(YEARLY) 요금제의 월 상당 금액 - 연 금액을 12 로 나눠 원 미만을 반올림(0.5 는 올림)한 값. 고객 화면의 「월 N원 상당」 줄을 이 값으로 그린다. 연간이 아니면 null 이다(줄을 그리지 않는다).
yearly_discount_percent:
anyOf:
- type: integer
maximum: 100.0
minimum: 0.0
- type: 'null'
title: Yearly Discount Percent
description: 연간(YEARLY) 요금제가 월간 결제를 열두 번 낸 합계보다 깎아 주는 비율(정수 %). 연 요금이 이 비율로 만들어진다는 정가표 규칙의 값이다 - 서버의 요율 상수 한 곳에서 오고, 요금제 행의 가격을 읽어 다시 계산한 값이 아니다. 연간이 아니면 null 이다.
quota_policy_id:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Quota Policy Id
description: 연결된 사용 토큰 한도 정책.
daily_token_limit:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Daily Token Limit
description: 'T12: daily usage-token allowance this plan grants, read from the linked quota_policies row (plans.quota_policy_id). The unit is usage tokens, not call count. null means THIS PLAN HAS NO DAILY CAP from a quota policy - do not read it as not-configured-yet. It covers four cases that are deliberately not distinguished: no policy linked, a linked policy whose own daily_limit is null, a linked policy that was soft-deleted, and the admin create/update responses (those are built from RETURNING, which this repository keeps narrow - read the plan again to get the limits).'
monthly_token_limit:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Monthly Token Limit
description: 'T12: monthly usage-token allowance from the same quota_policies row. NULL = no monthly limit for this plan (the user instruction gives a monthly number for the paid plans only). The unit is usage tokens.'
contact_sales:
type: boolean
title: Contact Sales
description: 상담으로 가입하는 요금제(엔터프라이즈)이면 true. 고객이 스스로 가입하는 길(0원 가입 · 결제 가입)에 서지 않는다. 입력값을 받지 않고 `code` 에서 유도한다(`CONTACT_SALES_PLAN_CODES`).
default: false
additionalProperties: false
type: object
required:
- plan_id
- code
- name
- tier
- billing_cycle
- price
- status
- env_scope
- created_at
title: PlanResponse
description: '요금제 단일 객체 응답.
SCHEMA → DTO 매핑:
- `plans.id` → `plan_id` (외부 노출 식별자명 — 표준 `<resource>_id` 패턴).
- `plans.code/name/description/tier/billing_cycle/status/env_scope/created_at` → 직접 매핑.
- `plans.price_amount_minor + currency + tax_included` → nested `MoneyMinor` 객체 `price`.
- `plans.metadata`/`updated_at`/`deleted_at`는 외부 노출 X(BFF/콘솔 미사용 + 정책 평가 키 보호).
SCHEMA가 글로벌 카탈로그이므로 `organization_id` 필드 없음.'
PlanCatalogOfferResponse:
properties:
plan:
$ref: '#/components/schemas/PlanResponse'
env_scope:
type: string
enum:
- sandbox
- real_test
- production
title: Env Scope
included_products:
items:
$ref: '#/components/schemas/PlanCatalogIncludedProductItem'
type: array
title: Included Products
addon_offers:
items:
$ref: '#/components/schemas/PlanCatalogAddonOfferItem'
type: array
title: Addon Offers
usage_unit_prices:
items:
$ref: '#/components/schemas/PlanCatalogUsageUnitPriceItem'
type: array
title: Usage Unit Prices
additionalProperties: false
type: object
required:
- plan
- env_scope
title: PlanCatalogOfferResponse
description: '`GET /v1/plans/{plan_id}/catalog-offer` Console subscribe catalog snapshot.'
PlanCatalogAddonOfferItem:
properties:
plan_addon_offer_id:
type: integer
minimum: 1.0
title: Plan Addon Offer Id
product_id:
type: integer
minimum: 1.0
title: Product Id
product_code:
type: string
maxLength: 64
minLength: 1
title: Product Code
product_name:
type: string
maxLength: 200
minLength: 1
title: Product Name
product_description:
anyOf:
- type: string
maxLength: 10000
- type: 'null'
title: Product Description
description: api_products.description projection for Console checkout copy. NULL when the catalog product has no description.
is_mcp_pack:
type: boolean
title: Is Mcp Pack
description: True when api_products.metadata marks an MCP package sale product (seed=mcp_package_addon_sale and/or mcp_package_id). Console may show a small MCP-pack label; not an entitlement SSOT.
recurring_amount_minor:
type: integer
exclusiveMinimum: 0.0
title: Recurring Amount Minor
currency:
type: string
maxLength: 3
minLength: 3
title: Currency
billing_cycle:
type: string
enum:
- MONTHLY
- YEARLY
title: Billing Cycle
additionalProperties: false
type: object
required:
- plan_addon_offer_id
- product_id
- product_code
- product_name
- is_mcp_pack
- recurring_amount_minor
- currency
- billing_cycle
title: PlanCatalogAddonOfferItem
description: Purchasable add-on offer for Console checkout (ACTIVE offers only).
PlanListQuery:
properties:
status:
anyOf:
- items:
type: string
enum:
- DRAFT
- ACTIVE
- DEPRECATED
- RETIRED
type: array
- type: 'null'
title: Status
description: 상태 필터. 미지정 시 ACTIVE+DEPRECATED 기본(노출 가능 행).
tier:
anyOf:
- type: string
enum:
- FREE
- PAID
- type: 'null'
title: Tier
description: 등급 필터.
limit:
type: integer
maximum: 100.0
minimum: 1.0
title: Limit
description: 페이지 크기. 1~100. 기본 20.
default: 20
cursor:
anyOf:
- type: string
- type: 'null'
title: Cursor
description: 이전 응답의 next_cursor.
type: object
title: PlanListQuery
description: '요금제 목록 조회 쿼리.
`env_scope`는 요청 헤더 `X-Env-Scope`에서 라우트 의존성으로 주입되므로 쿼리에 없다.
`deleted_at IS NULL` 필터는 서비스 레이어가 항상 적용한다(쿼리 미노출).'
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
MoneyMinor:
properties:
amount_minor:
type: integer
minimum: 0.0
title: Amount Minor
description: minor unit 정수 금액. KRW는 원 단위. 음수 금지 (SCHEMA CHECK 정합).
currency:
type: string
const: KRW
title: Currency
description: 통화 코드 (v1=KRW). 세 글자여야 한다.
tax_included:
type: boolean
title: Tax Included
description: 부가세 포함 여부. SCHEMA NOT NULL.
additionalProperties: false
type: object
required:
- amount_minor
- currency
- tax_included
title: MoneyMinor
description: "minor unit 정수 기반 금액 객체.\n\nSCHEMA 컬럼 `price_amount_minor BIGINT NOT NULL CHECK (>= 0)` +\n`currency CHAR(3) DEFAULT 'KRW'` + `tax_included BOOLEAN DEFAULT TRUE`를\nAPI 응답의 nested `price` 객체로 묶는다.\n\n- `amount_minor`: 1회 청구/결제 금액의 minor unit 정수(KRW는 원 단위, JPY는 엔 단위).\n 절대 float/Decimal 사용 금지(부동소수 오차 + JSON 직렬화 일관성).\n- `currency`: v1 단일 KRW. 통화 확장은 별도 ADR.\n- `tax_included`: 부가세 포함 여부. NULL 금지(SCHEMA NOT NULL DEFAULT TRUE 정합)."
PlanCatalogIncludedProductItem:
properties:
plan_product_mapping_id:
type: integer
minimum: 1.0
title: Plan Product Mapping Id
description: plan_products.id.
product_id:
type: integer
minimum: 1.0
title: Product Id
product_code:
type: string
maxLength: 64
minLength: 1
title: Product Code
product_name:
type: string
maxLength: 200
minLength: 1
title: Product Name
is_default:
type: boolean
title: Is Default
description: Default BASE mapping flag (plan_products.is_default).
additionalProperties: false
type: object
required:
- plan_product_mapping_id
- product_id
- product_code
- product_name
- is_default
title: PlanCatalogIncludedProductItem
description: BASE entitlement product row for Console checkout catalog-offer.
securitySchemes:
basicClientCredential:
type: http
scheme: basic
description: 'Console-issued client credential. Send `Authorization: Basic base64(client_id:client_secret)`.'
mcpOAuth2:
type: oauth2
description: For MCP clients. OAuth 2.0 authorization code flow with PKCE (S256) for public clients. The client_id is the HTTPS URL of an OAuth Client ID Metadata Document that XBOSS has allow-listed; dynamic client registration is not supported.
flows:
authorizationCode:
authorizationUrl: https://api.xdata.kr/oauth/authorize
tokenUrl: https://api.xdata.kr/oauth/token
scopes: {}