Apps

Read and configure your apps, and check onboarding status.

An app represents a single application on one platform. It holds your bundle identifier, store credentials, catalog, and paywalls. Most other endpoints are scoped to an app via its id in the path (shown as {app} below).

The app object#

idstring

Unique identifier, prefixed with app_.

namestring

Human-readable app name.

platformstring

The store platform: ios or android.

bundle_idstring

The app's bundle identifier (iOS) or package name (Android).

created_atstring

ISO 8601 creation timestamp.

List apps#

GET /v1/apps

Returns every app in your account, newest first. Supports limit and cursor pagination.

bash

curl https://api.cashsdk.com/v1/apps \
  -H "Authorization: Bearer csk_sk_..."

json

{
  "data": [
    {
      "id": "app_2mK4pQ",
      "name": "Focus Timer",
      "platform": "ios",
      "bundle_id": "com.example.focustimer",
      "created_at": "2026-05-02T09:14:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Retrieve an app#

GET /v1/apps/{app}

appstringrequired

The app ID, for example app_2mK4pQ.

bash

curl https://api.cashsdk.com/v1/apps/app_2mK4pQ \
  -H "Authorization: Bearer csk_sk_..."

json

{
  "id": "app_2mK4pQ",
  "name": "Focus Timer",
  "platform": "ios",
  "bundle_id": "com.example.focustimer",
  "created_at": "2026-05-02T09:14:00Z"
}

Update app settings#

PATCH /v1/apps/{app}

Update mutable app settings. Send only the fields you want to change.

appstringrequired

The app ID.

namestring

A new display name for the app.

bundle_idstring

Update the bundle identifier / package name.

bash

curl -X PATCH https://api.cashsdk.com/v1/apps/app_2mK4pQ \
  -H "Authorization: Bearer csk_sk_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Focus Timer Pro" }'

json

{
  "id": "app_2mK4pQ",
  "name": "Focus Timer Pro",
  "platform": "ios",
  "bundle_id": "com.example.focustimer",
  "created_at": "2026-05-02T09:14:00Z"
}

Retrieve the setup checklist#

GET /v1/apps/{app}/setup/checklist

Returns the live onboarding checklist for an app — each step and whether it is complete. Useful for surfacing provisioning progress in your own tooling.

appstringrequired

The app ID.

completeboolean

true when every required step is done.

itemsarray

The individual checklist items.

Show item

keystring

Stable identifier for the step, e.g. store_credentials.

labelstring

Human-readable description of the step.

completeboolean

Whether this step is satisfied.

bash

curl https://api.cashsdk.com/v1/apps/app_2mK4pQ/setup/checklist \
  -H "Authorization: Bearer csk_sk_..."

json

{
  "complete": false,
  "items": [
    { "key": "store_credentials", "label": "Connect App Store credentials", "complete": true },
    { "key": "products",          "label": "Add at least one product",       "complete": true },
    { "key": "paywall",           "label": "Publish a paywall",              "complete": false },
    { "key": "webhook",           "label": "Register a webhook endpoint",    "complete": false }
  ]
}

Next steps#

Catalog

Add products and entitlements to your app.

Paywalls

Publish a remote paywall.