How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xdata-kr Billing Subscriptions API

The Billing Subscriptions API from xdata-kr — 16 operation(s) for billing subscriptions.

xdata-kr Billing Subscriptions API is one of 31 APIs that xdata-kr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 16 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

18 operations 16 paths 33 schemas 5 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

xdata-kr Billing Subscriptions API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicClientCredential). It supports OAuth 2.0 (mcpOAuth2) using the authorizationCode flow. By default, every request must be authenticated.

  • basicClientCredential — Console-issued client credential. Send Authorization: Basic base64(clientid:clientsecret).
  • mcpOAuth2 — For MCP clients. OAuth 2.0 authorization code flow with PKCE (S256) for public clients. The clientid is the HTTPS URL of an OAuth Client ID Metadata Document t…

Paths & Operations 18

Across 16 paths, the API surfaces 18 operations — 5 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Billing Subscriptions 18
POST
/v1/subscriptions/zero-price-plan
Join a price-0 plan without a payment (quotatokenv1 6-6)
join_zero_price_plan_route_v1_subscriptions_zero_price_plan_post 3 params body → 200422
POST
/v1/subscriptions/quote
Preview hybrid subscribe invoice (no DB write)
quote_subscription_v1_subscriptions_quote_post 3 params body → 200422
POST
/v1/subscriptions
Create Subscription
create_subscription_v1_subscriptions_post 4 params body → 202422
GET
/v1/subscriptions
List Subscriptions
list_subscriptions_v1_subscriptions_get 4 params → 200422
GET
/v1/subscriptions/{subscription_id}
Get Subscription
get_subscription_v1_subscriptions__subscription_id__get 4 params → 200422
GET
/v1/subscriptions/{subscription_id}/usage-summary
Get Subscription Usage Summary
get_subscription_usage_summary_v1_subscriptions__subscription_id__usage_summary_get 4 params → 200422
POST
/v1/subscriptions/{subscription_id}/addons/preview
Preview mid-life Path B add-on charge (no DB write)
preview_subscription_addons_v1_subscriptions__subscription_id__addons_preview_post 4 params body → 200422
POST
/v1/subscriptions/{subscription_id}/addons
Mid-life Path B add-on charge (ACTIVE subscription)
add_subscription_addons_v1_subscriptions__subscription_id__addons_post 5 params body → 202422
POST
/v1/subscriptions/{subscription_id}/addons/{product_id}/cancel
Cancel one Path B pack (next renewal excluded)
cancel_subscription_addon_v1_subscriptions__subscription_id__addons__product_id__cancel_post 6 params → 200422
POST
/v1/subscriptions/{subscription_id}/cancel
Cancel Subscription
cancel_subscription_v1_subscriptions__subscription_id__cancel_post 5 params body → 200422
POST
/v1/subscriptions/{subscription_id}/pause
Pause Subscription
pause_subscription_v1_subscriptions__subscription_id__pause_post 5 params body → 200422
POST
/v1/subscriptions/{subscription_id}/resume
Resume Subscription
resume_subscription_v1_subscriptions__subscription_id__resume_post 5 params body → 200422
GET
/v1/subscriptions/{subscription_id}/cancel-refund-quote
구독 해지 환불 견적
get_cancel_refund_quote_v1_subscriptions__subscription_id__cancel_refund_quote_get 4 params → 200422
POST
/v1/subscriptions/{subscription_id}/payment-method
Attach a registered payment method to an existing subscription
attach_subscription_payment_method_v1_subscriptions__subscription_id__payment_method_post 5 params body → 200422
GET
/v1/subscriptions/{subscription_id}/payment-retry
Preview paying a PAYMENTFAILED subscription again with its attached card (no…
get_subscription_payment_retry_v1_subscriptions__subscription_id__payment_retry_get 4 params → 200422
POST
/v1/subscriptions/{subscription_id}/payment-retry
Pay a PAYMENTFAILED subscription's open invoice again with its attached card
retry_subscription_payment_v1_subscriptions__subscription_id__payment_retry_post 5 params body → 200422
POST
/v1/subscriptions/{subscription_id}/upgrade/quote
Preview a plan upgrade: what is charged today and the remaining-period credit…
quote_subscription_upgrade_v1_subscriptions__subscription_id__upgrade_quote_post 4 params body → 200422
POST
/v1/subscriptions/{subscription_id}/upgrade
Upgrade to a higher plan: credit the unused remainder, charge the card, switch…
upgrade_subscription_v1_subscriptions__subscription_id__upgrade_post 5 params body → 202422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are SubscriptionUpgradeQuoteResponse (17 properties), SubscriptionUpgradeResponse (14 properties), SubscriptionResponse (13 properties), SubscriptionQuoteResponse (11 properties). Each schema is shown below with its type and property counts.

SubscriptionQuoteResponse
object
Quote preview envelope (no invoice/payment ids). New-subscribe POST /quote leaves mid-life-only fields unset. Mid-life POST .../addons/preview sets subscriptio…
11 properties 8 required
SubscriptionResponse
object
구독 단일 객체 응답. SCHEMA → DTO 매핑: - subscriptions.id → subscriptionid. - organizationid/paymentmethodid/status/envscope/currentperiod/nextbillingat/ graceperiodunt…
13 properties 6 required
SubscriptionPaymentRetryPreviewResponse
object
읽기 응답 - 「다시 결제」 단추를 그릴지와 그 화면에 보일 값.
6 properties 3 required
PaymentRetryPaymentMethod
object
구독에 지금 붙은 결제수단 - 화면에 보일 것만 싣는다(제공자 이름 · 빌키 등 내부 값은 싣지 않는다).
4 properties 1 required
SubscriptionUsageSummaryResponse
object
GET /v1/subscriptions/{id}/usage-summary 응답 - 실사용 축이고 청구 계산과 무관하다. 콘솔 "이번 결제주기 사용량" 표시 전용 — usedquantity 는 집계(청구 확정) + 미집계(pending) 사용량을 모두 합산한 값이라 청구에 쓰이는 집계된…
7 properties 4 required
SubscriptionPaymentMethodAttachRequest
object
구독이 쓸 결제수단. 구독과 같은 조직의 ACTIVE 결제수단이어야 한다(서비스가 가린다).
1 property 1 required
SubscriptionListQuery
object
구독 목록 조회 쿼리. 상위 계약에 쿼리 표가 없어 이 DTO 가 그 자리를 대신한다. 자동 필터(라우트 강제): - organizationid: 본인 조직(운영자 adminuser 는 명시 organizationid 전달 가능) - envscope = X-Env-Scope (헤더)…
4 properties
SubscriptionCreateResponse
object
구독 생성 응답 - 202 Accepted 의 몸통. 조회 응답과 다른 객체: - 본 응답은 첫 청구/결제 식별자(firstinvoiceid/firstpaymentid)를 포함하여 BFF가 즉시 결제 진행 상태를 폴링/구독할 수 있도록 한다. - 본 응답에는 nested plan 객체…
9 properties 8 required
SubscriptionResumeRequest
object
구독 재개 요청 - POST .../resume 의 본문. 허용 권한: 운영자(BILLINGADMIN·SYSADMIN, requestkind=billing) 전용. 본문은 비어 있어야 한다(빈 {}). extra='forbid'로 미선언 필드 거부.
1 property
SubscriptionCancelRequest
object
구독 취소 요청 - POST .../cancel 의 본문. 허용 권한: 본인 조직 OWNER 또는 운영자(BILLINGADMIN·SYSADMIN, requestkind=billing). 본문 { "reason": "USERREQUEST" }(선택)를 DTO 단에서 enum으로 잠근다.
2 properties
SubscriptionPauseRequest
object
구독 일시중지 요청 - POST .../pause 의 본문. 허용 권한: 운영자(BILLINGADMIN·SYSADMIN, requestkind=billing) 전용. reason의 기본값은 OPSHOLD다.
2 properties
ZeroPricePlanJoinRequest
object
결제 없이 그 요금제의 ACTIVE 구독을 만든다. 같은 요금제에 다시 부르면 바뀌는 것 없이 같은 구독이 온다 - 그래서 Idempotency-Key 를 받지 않는다.
2 properties 2 required
ZeroPricePlanJoinResponse
object
6 properties 6 required
SubscriptionUpgradeQuoteResponse
object
업그레이드 견적 - 오늘 낼 돈과 그 까닭(남은 기간 크레딧). planid 는 바꿀 요금제, subscriptionid 는 바꾸려는 지금 구독이다. subtotal/tax/totalamountminor 와 lineitems 는 발행될 청구서와 같다 (totalamountminor =…
17 properties 14 required
PageEnvelope_SubscriptionResponse_
object
3 properties
ValidationError
object
5 properties 3 required
SubscriptionAddonItemResponse
object
ACTIVE Path B subscriptionitems projection (custom-plan P1-sub / U3). Mapped from SubscriptionItemRepository.listactiveitemsnapshotsforsubscription.
4 properties 4 required
SubscriptionUpgradeQuoteRequest
object
업그레이드 견적 요청 - 어느 상위 요금제로, 무슨 카드로.
3 properties 2 required
SubscriptionPaymentRetryResponse
object
쓰기 응답 - 거절(FAILED)은 응답이 아니라 402 오류로 온다. paymentstatus 가 PENDING 이면 결과를 모르는 승인이거나 웹훅을 기다리는 청구다 - 실패로 적지 않는다(카드사에서는 승인됐을 수 있다). 그때 subscriptionstatus 는 PAYMENTFA…
8 properties 8 required
SubscriptionAddonAddRequest
object
Mid-life Path B add-on purchase on an ACTIVE subscription. Does not create a subscription. Charges add-on + tax only (no plan re-bill). Path B subscriptionitem…
3 properties 2 required
SubscriptionQuoteLineItem
object
Preview line item mirroring invoice issue input.
8 properties 6 required
SubscriptionUpgradeRequest
object
업그레이드 실행 요청 - 견적 입력과 같다. 본문이 같아야 같은 Idempotency-Key 의 재시도가 같은 요청으로 읽힌다.
3 properties 2 required
SubscriptionQuoteRequest
object
Hybrid subscribe quote preview. No DB write; no Idempotency-Key.
3 properties 2 required
SubscriptionAddonAddResponse
object
202 Accepted mid-life add-on charge snapshot (invoice + payment INITIATED).
9 properties 8 required
PlanSummary
object
요금제 요약 객체(nested 응답용). GET /v1/subscriptions/{id} 응답 등 다른 자원이 요금제를 nested로 표시할 때 사용한다. 전체 PlanResponse(가격·주기·메타 포함)보다 가벼운 요약으로 분리 (응답 크기 최소화 + BFF 캐시 효율). name…
4 properties 4 required
PaymentRetryInvoice
object
다시 결제로 청구될 미결제 청구서.
3 properties 3 required
SubscriptionPaymentRetryRequest
object
다시 결제 요청 - 화면이 보여 준 카드 번호 하나.
1 property 1 required
SubscriptionCancelRefundQuote
object
계산기가 낸 환불 견적 (outcome 이 QUOTED 일 때만 있다). 모든 금액은 세금 포함 minor unit(원)이다.
8 properties 8 required
SubscriptionAddonPreviewRequest
object
Mid-life Path B add-on charge preview (no DB write; no Idempotency-Key).
2 properties 2 required
SubscriptionCancelRefundQuoteResponse
object
GET /v1/subscriptions/{subscriptionid}/cancel-refund-quote 응답.
5 properties 3 required
SubscriptionUpgradeResponse
object
업그레이드 실행 결과 - 의도와 청구서 · 결제 번호, 지금 상태. status 는 응답을 만들 때의 의도 상태다: 카드 승인까지 끝났으면 SWITCHED(+ tosubscriptionid), 결과를 모르면(타임아웃) PENDINGPAYMENT 로 남는다. 카드가 거절되면 이 응답이…
14 properties 13 required
HTTPValidationError
object
1 property
SubscriptionCreateRequest
object
구독 생성 요청. 처리 흐름: 1) AuthPolicyService 평가(requestkind='billing', OWNER/ADMIN) 2) plan/paymentmethod 소유권·상태·envscope 검증 3) subscriptions 행 PENDING 생성 4) invoices…
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xdata-kr-billing-subscriptions-api-openapi.yml Raw ↑

Other APIs xdata-kr publishes across the network.

xdata-kr App Credential API
xdata-kr Auth API
xdata-kr Auth Handoff API
xdata-kr Billing Invoices API
xdata-kr Billing Payment Methods API
xdata-kr Billing Payments API
xdata-kr Billing Plans API
xdata-kr Billing Refunds API
xdata-kr Billing Standard Checkout API
xdata-kr Billing Webhooks API
xdata-kr Composite Pack API
xdata-kr Console Self Service API
Where this information came from

This is an independent, third-party profile of xdata-kr Billing Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.