STstripe

Create an app install

Changed on

Creates an app install. An account installs its own private app with its own key; public and testing installs are made from the Dashboard. An app developer or embedding platform acting on a connected account through Stripe-Account installs or reinstalls its app there. For a private app, creating an install installs the newest completed upload; when that version is already installed with nothing pending, the existing install is returned.

post/v1/apps/installs

Request

Request body application/x-www-form-urlencoded

appstring required

The ID of the app to install.

channel'private_live' | 'private_test' | 'public' | 'testing'

The distribution channel to install from. Defaults to public. A private app must be installed on private_test or private_live, matching the mode of the API key.

code_challengestring

For OAuth apps, the PKCE code challenge used to issue the auth_code returned on the install. Must be 43 to 128 characters and contain only letters, numbers, -, ., _, and ~. Only applies to installs made by the app developer or an embedding platform; ignored when an account installs its own private app.

code_challenge_methodstring

The method used to derive code_challenge. Required when code_challenge is provided, and must be S256.

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

accountstring required

The ID of the account that the app install belongs to.

appstring required

The ID of the app installed.

approval_requiredboolean required

Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps, approval_required stays false; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions.

auth_codestring nullable

The authorization code for an oauth app install.

channel'private_live' | 'private_test' | 'public' | 'review' | 'testing' required

The distribution channel associated with the app install.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

created_bystring nullable

The ID of the embedding platform that created the install, if applicable.

endpoints_grantedstring[] required

The endpoint URLs authorized by the installer.

endpoints_pendingstring[] required

The endpoint URLs requested by the latest app version that the installer has not authorized.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'apps.install' required

String representing the object's type. Objects of the same type share the same value.

permissions_grantedstring[] required

The permissions authorized by the installer.

permissions_pendingstring[] required

The permissions requested by the latest app version that the installer has not authorized.

status'install_failed' | 'installed' | 'installing' | 'uninstall_failed' | 'uninstalling' required

The status of the app install.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.