DOCSEARCHbyAlgolia
Submit Docs

Stripe Apps Platform

repository·main·Indexed 41 days ago

https://github.com/stripe/stripe-apps

A platform for developers to build and embed custom user experiences and workflows directly into the Stripe Dashboard. Includes tools for orchestrating the Stripe API, a manifest JSON schema via @stripe/app-manifest-schema for configuration validation, and guidelines for publishing to the Stripe App Marketplace.

Tokens
802
Snippets
2
Records
6
Agent score
53%

What's inside Stripe Apps

  1. Overview of Stripe Apps

    main
    Stripe Apps allow developers to embed custom user experiences directly within the Stripe Dashboard and orchestrate the Stripe API. This enables the creation of specialized tools and workflows that live alongside native Stripe functionality.

  2. Understand the Stripe Apps manifest JSON schema

    main
    The @stripe/app-manifest-schema package provides the JSON schema used to validate the stripe-app.json manifest file required for Stripe Apps. This schema ensures that your app's configuration, permissions, and metadata conform to the expected structure. The schema is also available via the JSON Schema Store catalog for IDE integration and automated validation.

  3. Publishing to the Stripe App Marketplace

    main

    To make your Stripe App discoverable to all users, you can publish it to the Stripe App Marketplace. Before publishing, you must ensure your app complies with the following requirements:

  4. Setup the Pizzazz Loyalty Program example app

    main

    To run the Pizzazz Loyalty Program example, which demonstrates building a full-page Stripe App with member management and rewards, follow these steps:

    Prerequisites

    • Node.js: version 18 or higher
    • Stripe CLI: must have the stripe apps plugin installed
    • pnpm: package manager

    Installation and Local Development

    1. Install dependencies using pnpm:
      pnpm install
    2. Start the app locally:
      pnpm start
      This command executes stripe apps start, which launches the app in your Stripe Dashboard in development mode.
    3. Build for production:
      pnpm build
    pnpm install
pnpm start
pnpm build

  6. Available scripts for the Pizzazz Loyalty Program example

    main

    The following scripts are available in the Pizzazz Loyalty Program example project:

    • pnpm lint: Runs ESLint on all TypeScript source files.
    • pnpm typecheck: Performs type-checking on the project without emitting files.
    • pnpm test: Executes the test suite using Jest.
    | Script           | Description                                   |
| ---------------- | --------------------------------------------- |
| `pnpm lint`      | Run ESLint on all TypeScript source files     |
| `pnpm typecheck` | Type-check the project without emitting files |
| `pnpm test`      | Run the test suite with Jest                  |