paydirt_setup
Initiates Paydirt setup by returning an authorization URL and finish arguments, or checks a setup session's status when a session ID is provided.
Instructions
Use this when an older client expects the single setup tool. Without session_id it starts setup and immediately returns authorization_url plus finish arguments; with session_id it checks once and returns pending, expired, or the complete installation contract. It never opens a browser or blocks. New agents should prefer paydirt_begin_setup and paydirt_finish_setup.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_id | No | Existing Paydirt app ID, including the ID in a website setup handoff. Reconnect this exact app and reuse its saved Slack/delivery settings instead of creating another app. | |
| 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 | Confirmed feedback experiences to install. The recommended plan is Suggest a Feature plus trial and paid cancellation when subscriptions exist. | |
| session_id | No | Setup session returned by the first call. When present, this call behaves like paydirt_finish_setup. | |
| app_description | No | Optional app description to save when creating or repairing setup | |
| uses_revenuecat | No | Deprecated compatibility input. Prefer subscription_provider. | |
| feature_placement | No | Developer-confirmed placement for Suggest a Feature, such as settings or after_successful_export. Defaults to settings. | |
| form_plan_confirmed | No | Set true when the developer explicitly requested these voice forms or confirmed the proposed plan. An explicit installation request already confirms its scope; do not ask the same question again. Ask only when the requested forms or placement are ambiguous. | |
| 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 |