# Sylius Documentation ## Public Sylius Documentation - [Sylius Documentation](https://docs.sylius.com/public/readme.md): Welcome to your team’s developer platform - [Introduction to Sylius](https://docs.sylius.com/public/what-is-sylius/introduction-to-sylius.md) - [Architecture](https://docs.sylius.com/public/what-is-sylius/architecture.md) - [Choosing Sylius: When and Why](https://docs.sylius.com/public/what-is-sylius/choosing-sylius-when-and-why.md) - [Release Cycle](https://docs.sylius.com/public/open-source/release-cycle.md) - [Backwards Compatibility Promise](https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md) - [Contributing](https://docs.sylius.com/public/open-source/contributing.md) - [Contributing Code](https://docs.sylius.com/public/open-source/contributing/contributing-code.md) - [Submitting a Patch](https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md) - [Security Issues](https://docs.sylius.com/public/open-source/contributing/contributing-code/security-issues.md) - [Coding Standards](https://docs.sylius.com/public/open-source/contributing/contributing-code/coding-standards.md) - [Conventions](https://docs.sylius.com/public/open-source/contributing/contributing-code/conventions.md) - [Sylius License and Trademark](https://docs.sylius.com/public/open-source/contributing/contributing-code/sylius-license-and-trademark.md) - [Contributing Documentation](https://docs.sylius.com/public/open-source/contributing/contributing-documentation.md) - [Contributing Translations](https://docs.sylius.com/public/open-source/contributing/contributing-translations.md) - [Key Contributors](https://docs.sylius.com/public/open-source/contributing/key-contributors.md) - [Before You Begin](https://docs.sylius.com/public/getting-started/before-you-begin.md) - [Installation with Docker](https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md) - [Installation without Docker](https://docs.sylius.com/public/getting-started/sylius-ce-installation.md) - [Basic Configuration](https://docs.sylius.com/public/getting-started/basic-configuration.md) - [Shipping & Payment](https://docs.sylius.com/public/getting-started/shipping-and-payment.md) - [First Product](https://docs.sylius.com/public/getting-started/first-product.md) ## Stripe Plugin - [Sylius Stripe Plugin](https://docs.sylius.com/public/stripe-plugin/sylius-stripe-plugin.md) - [Installation](https://docs.sylius.com/public/stripe-plugin/installation.md) - [Manual Installation](https://docs.sylius.com/public/stripe-plugin/installation/manual-installation.md) - [Supported payment methods](https://docs.sylius.com/public/stripe-plugin/supported-payment-methods.md): See which Stripe payment methods work with the plugin and how Stripe decides what to show. - [Stripe App & Restricted API Key](https://docs.sylius.com/public/stripe-plugin/getting-started/stripe-app-and-restricted-api-key.md) - [Configure your first payment method](https://docs.sylius.com/public/stripe-plugin/getting-started/configure-your-first-payment-method.md): Create a Stripe payment method in Sylius and connect its webhook endpoint. - [Verify the setup](https://docs.sylius.com/public/stripe-plugin/getting-started/verify-the-setup.md): Run a real test payment and confirm the plugin, Stripe, and webhook flow work end to end. - [Testing](https://docs.sylius.com/public/stripe-plugin/getting-started/testing.md): Validate your Stripe integration locally, end to end, and on staging. - [Plugin development](https://docs.sylius.com/public/stripe-plugin/getting-started/plugin-development.md): Set up the bundled test application and run the contributor test suites. - [Comparing gateways](https://docs.sylius.com/public/stripe-plugin/payment-gateways/comparing-gateways.md): Compare Stripe Checkout and Stripe Web Elements, and run both on the same channel. - [Stripe (Checkout)](https://docs.sylius.com/public/stripe-plugin/payment-gateways/stripe-checkout.md): Use Stripe-hosted Checkout for a redirect-based payment flow. - [Stripe (Web Elements)](https://docs.sylius.com/public/stripe-plugin/payment-gateways/stripe-web-elements.md): Use Stripe Payment Element on a Sylius page. - [Webhooks](https://docs.sylius.com/public/stripe-plugin/features/webhooks.md): Stripe webhooks drive Sylius payment state transitions. - [Endpoint URL & required events](https://docs.sylius.com/public/stripe-plugin/features/webhooks/endpoint-url-and-required-events.md): Register the correct webhook endpoint and subscribe to the required Stripe events. - [Signature verification & secret rotation](https://docs.sylius.com/public/stripe-plugin/features/webhooks/signature-verification-and-secret-rotation.md): Validate Stripe signatures and rotate webhook secrets without downtime. - [Local development with Stripe CLI](https://docs.sylius.com/public/stripe-plugin/features/webhooks/local-development-with-stripe-cli.md): Forward Stripe events to your local Sylius instance. - [Capture modes](https://docs.sylius.com/public/stripe-plugin/features/capture-modes.md): Choose immediate or delayed capture for Stripe payments. - [Express Checkout](https://docs.sylius.com/public/stripe-plugin/features/express-checkout.md): Add wallet buttons on the cart page and checkout sidebar. - [Refunds](https://docs.sylius.com/public/stripe-plugin/features/refunds.md): Issue full or partial refunds from the Sylius admin. - [Payment form appearance](https://docs.sylius.com/public/stripe-plugin/features/payment-form-appearance.md): Restyle Stripe Payment Element from the Sylius admin, without template overrides. - [Adaptive Pricing](https://docs.sylius.com/public/stripe-plugin/features/adaptive-pricing.md): Show buyer-local currency on Stripe Checkout while settling in your own currency. - [Subscriptions](https://docs.sylius.com/public/stripe-plugin/features/subscriptions.md): Understand what subscription-mode Checkout supports out of the box and what you must add yourself. - [Codebase map](https://docs.sylius.com/public/stripe-plugin/architecture/codebase-map.md): Reference the plugin's src layout, subsystem boundaries, and service wiring. - [PaymentRequest command pipeline](https://docs.sylius.com/public/stripe-plugin/architecture/paymentrequest-command-pipeline.md): See how Sylius workflow transitions become Stripe API calls. - [Two stacks — Checkout vs Web Elements](https://docs.sylius.com/public/stripe-plugin/architecture/two-stacks-checkout-vs-web-elements.md): Understand why the plugin mirrors most internals across Checkout and Web Elements. - [Params provider composite](https://docs.sylius.com/public/stripe-plugin/architecture/params-provider-composite.md): Learn how tagged providers assemble Stripe API payloads. - [State machine integration](https://docs.sylius.com/public/stripe-plugin/architecture/state-machine-integration.md): See how Sylius workflow events and Stripe object states stay in sync. - [Metadata on PaymentIntents / Sessions](https://docs.sylius.com/public/stripe-plugin/customization-guide/metadata-on-paymentintents-sessions.md): Add custom Stripe metadata and use it in support flows, webhooks, and Radar rules. - [Replacing or adding params providers](https://docs.sylius.com/public/stripe-plugin/customization-guide/replacing-or-adding-params-providers.md): Change Stripe API payloads by adding, decorating, or replacing params providers. - [Custom shipping rates for Express Checkout](https://docs.sylius.com/public/stripe-plugin/customization-guide/custom-shipping-rates-for-express-checkout.md): Override wallet shipping options for Express Checkout based on your own business rules. - [Custom webhook event processors](https://docs.sylius.com/public/stripe-plugin/customization-guide/custom-webhook-event-processors.md): React to extra Stripe events by adding your own webhook event processors. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.sylius.com/public/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.