Request
Call this endpoint with the access token of the installation. Dodo Payments finds the installation from the token, so the request has no installation ID. Use the API host of the installation:https://test.dodopayments.com for a test install or https://live.dodopayments.com for a live install.
The token needs the
app_settings:read scope. Dodo Payments adds this scope to the access tokens of your app. You do not request it. A token without the scope gets a 403 response.Response
The manifest version of the last save. It is
null if the merchant never saved settings.The version that is live now. If
manifest_version is lower, the merchant has not yet seen the newest fields.The values of the non-secret fields, by key. It is
{} if nothing is saved. Only keys of the live manifest are included.The values of the
secret fields, by key. It is {} if nothing is saved. Do not log these values.No saved settings
If the merchant has not saved settings, you get a normal200 response:
action_needed is true here only if the manifest has a required field.
Handle action_needed
An installation withaction_needed set to true is still active. Dodo Payments does not block it. Your app decides what to do. For example, stop sync jobs until the merchant finishes the setup, and use invalid_keys to tell the merchant which fields to fix.