SubXDocs

Getting Started

A step-by-step guide to implementing in-app subscription payments with SubX. You can complete the basic setup in 5 minutes.

1. Create a Project

After signing up and accessing the dashboard, you will be prompted to create your first project. A project is the top-level unit corresponding to a single app (or service).

After creating a project, register your app.

  • iOS iOS app: Enter the Apple Bundle ID (e.g. com.example.myapp).
  • Android Android app: Enter the Google Play package name.

Register apps from the Apps menu in the dashboard sidebar.

2. Store Integration

Once your app is registered, you need to connect SubX with the Apple App Store or Google Play Store. In this step, obtain an API key from the store and register SubX's notification URL with the store.

상세 가이드: Store Setup에서 App Store Connect / Google Play Console에서 키를 발급받고 SubX에 입력하는 전체 과정을 스크린샷과 함께 안내합니다.

3. Register Store Products

First create in-app products in Apple App Store Connect or Google Play Console, then register Products with the same identifiers in the Products menu of the SubX dashboard.

{
  "identifier": "com.example.pro.monthly",
  "displayName": "Pro 월간 구독",
  "appId": "app_xxxx",
  "storeProductId": "com.example.pro.monthly"
}

4. Configure Entitlements

An Entitlement represents a feature permission to grant to users. For example, create a pro entitlement and connect both monthly and annual subscription Products so users get the same Pro features regardless of which plan they pay for.

// Entitlement 생성
POST https://api.subx.dev/v1/projects/{id}/entitlements
{
  "lookupKey": "pro",
  "displayName": "Pro 회원"
}

// Product 연결
POST https://api.subx.dev/v1/projects/{id}/entitlements/{eid}/products
{
  "productIds": ["product_monthly_id", "product_annual_id"]
}

5. Configure Offerings

An Offering is the bundle of products queried by the SDK. Add multiple Packages to an Offering and connect a Product to each Package.

// Offering 생성
POST https://api.subx.dev/v1/projects/{id}/offerings
{
  "lookupKey": "default",
  "displayName": "기본 오퍼링",
  "isCurrent": true
}

// Package 추가 후 Product 연결
POST https://api.subx.dev/v1/projects/{id}/offerings/{oid}/packages
{
  "lookupKey": "$rc_monthly",
  "displayName": "월간 플랜"
}

POST https://api.subx.dev/v1/projects/{id}/offerings/{oid}/packages/{pid}/products
{
  "productIds": ["product_monthly_id"]
}

6. Generate API Key

Generate a key from the API Keys menu in the dashboard.

중요: Important: API keys are only shown in full immediately after creation. Copy it right away and store it somewhere safe.

Next Steps

  • Store Setup — App Store Connect / Google Play Console 설정 방법을 확인합니다.
  • Core Concepts — Product, Entitlement, Offering, Package의 관계를 이해합니다.
  • SDK Integration — iOS/Android 앱에 SubX SDK를 연동합니다.
  • REST API — 전체 API 엔드포인트를 확인합니다.
  • Webhooks — 서버에서 구독 이벤트를 수신합니다.
Getting Started | SubX