paydirt_begin_setup
Begin Paydirt setup for a new user, machine, or iOS app. Get authorization URL and session ID instantly, without launching a browser.
Instructions
Use this when installing Paydirt for a new user, machine, or iOS app and authentication has not been completed. Inspect the host first and pass its app identity, use cases, and subscription provider. Returns authorization_url, session_id, and exact finish_arguments immediately; it never launches a browser, sleeps, or polls.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_name | No | Preferred app name to reuse or create during setup | |
| bundle_id | No | Preferred iOS bundle ID to match during setup | |
| use_cases | No | Feedback experiences to install. Defaults to regular feedback, trial cancellation, and subscription cancellation. | |
| app_description | No | Optional app description to save when creating or repairing setup | |
| uses_revenuecat | No | Deprecated compatibility input. Prefer subscription_provider. | |
| subscription_provider | No | Subscription source of truth discovered in the host app. Use auto only when it could not be resolved before setup. | |
| subscription_product_ids | No | Native StoreKit auto-renewable product IDs. Required for a complete storekit integration. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| message | No | ||
| success | Yes |