stripe-app.json (SchemaStore) JSON Schema

Type	object
File match	`stripe-app.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/stripe-app-json/latest.json
Source	https://raw.githubusercontent.com/stripe/stripe-apps/main/schema/stripe-app.schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

A manifest describing a Stripe App.

Properties

id string required

The unique identifier for an app, for example com.invoicing.myapp.

pattern=^[a-zA-Z0-9_\-\.]+$

version string required

An app version that you define. You can use any format you want for version identifiers.

minLength=1

name string required

The name shown in the UI when referring to your app.

minLength=1

icon string required

The relative path to a 300x300 pixel PNG image, for example ./icon.png.

pattern=^$|^\./((\.\./|[a-zA-Z0-9_/\-\\])[^\.\.]*\.png)$

permissions object[] required

The permissions available to the app. Read more about permissions.

ui_extension object required

Configuration options for how to display the app in the Dashboard.

2 nested properties

views object[]

Configure where the app appears in the Dashboard.

content_security_policy object

Configure the content security policy for your app.

3 nested properties

purpose string required

A message to show users when the app is installed that explains why the app needs to communicate with external URLs.

connect-src array | null

URLs of permitted third-party APIs. If the URL ends in a slash, all of its children also receive permission. Read about using third-party APIs.

image-src array | null

URLs the Img component can load from. If the URL ends in a slash, all trailing paths are also permitted.

$schema string

post_install_action null | object | object

Specify a recommended action users should take after installing your app. Read more about post-install actions.

constants object | null

Custom values that are passed through to your views via context props. Read about context props.

allowed_redirect_uris array | null

A list of allowed urls to which the user can be redirected upon successful install of this app. Read about using allowed redirect urls.

distribution_type string

Stripe Apps gives you two ways to distribute your apps. You can make them publicly available or privately share them only with your team member. Read about specifying Distribution Type.

Values: "public" "private"

stripe_api_access_type string

A property that describes how your application accesses Stripe API. Read about specifying Stripe API access type.

Values: "restricted_api_key" "oauth" "platform"

sandbox_install_compatible boolean

A property that when set to true will allow your app to be installable into a sandbox. Read about Sandbox compatibility.

Definitions

postInstallActionType

The recommended action for users to take after installing your app. Read about post-install actions.