---
title: "create checkout · RUAL Documentation"
description: "Creates a Stripe Checkout Session and returns the url of Stripe's hosted payment page to redirect the customer to. No card data reaches this cluster. Ei…"
canonical: https://docs.rual.nl/block-types/stripe/stripeconnection_checkout_create
language: en
---

# create checkout

This block is part of the [`stripe`](https://docs.rual.nl/block-types/stripe) group and was last modified in core [`v15.0.0`](https://docs.rual.nl/core-versions/150000).

Creates a Stripe Checkout Session and returns the **url** of Stripe's hosted payment page to redirect the customer to. No card data reaches this cluster. Either wire `line_items`, or give `amount` + `product name` for a one-off price that needs nothing set up in Stripe first.

- flow `flow`

- connection required `stripeconnection`

- mode `value` `payment` for a one-off charge, `subscription` for recurring billing, `setup` to save a card without charging it. • Suggestions: `payment` `subscription` `setup`

Default `payment`

- success url required `value` Where Stripe sends the customer after paying. Include `{CHECKOUT_SESSION_ID}` in the URL to get the session id back for checkout get.

- cancel url required `value` Where Stripe sends the customer if they back out.

- amount `number` Amount in the smallest currency unit : €10.00 is `1000`. Used with product name to build a one-off price; ignored when line items is wired.

- currency `value` Three-letter ISO code, lowercase. Default `eur`.

- product name `value` What the customer sees on the payment page, e.g. "Consultation". Required for the one-off price path.

- quantity `number` Default 1.

- interval `value` Subscription mode only: how often to bill the one-off price. `day`, `week`, `month` or `year`. Default `month`. • Suggestions: `day` `week` `month` `year`

- interval count `number` Subscription mode only: bill every N intervals, e.g. 3 with `month` for quarterly.

- line items `array ` Full Stripe line items, e.g. `[{"price":"price_123","quantity":2}]`. Wins over the amount/product name pins. Required for subscriptions to an existing Price.

- customer id `value` An existing Stripe customer (cus_…). Links the payment to their billing history and saved cards.

- customer email `value` Prefills the email field. Ignored when a customer id is given.

- reference `value` Your own id for this checkout : an order GUID. Comes back on the session and on the webhook event.

- meta data `object` Arbitrary key/values stored on the session and echoed back by webhooks.

- payment methods `array ` Restrict the methods offered, e.g. `["ideal","card"]`. Leave empty to let Stripe choose from what the account has enabled.

- locale `value` Language of the payment page, e.g. `nl`. Default is the customer's browser.

- trial days `number` Subscription mode only: free days before the first charge.

- allow promo codes `boolean` Shows a discount code field on the payment page.

- automatic tax `boolean` Let Stripe Tax calculate VAT. Requires Stripe Tax to be set up on the account.

- idempotency key `value` Optional. Reusing a key makes Stripe replay the first response instead of creating a second object : wire something stable per order, like the order GUID.

- flow `flow`

- connection `stripeconnection`

- pay url `value` Stripe's hosted payment page. Redirect the customer here. **Expires after 24 hours.**

- session id `value` cs_… : keep it on the order so checkout get can confirm the payment later.

- session `object` The full Checkout Session object.

- payment intent id `value`

- customer id `value`

- amount total `number` In the smallest currency unit.

- currency `value`

- meta data `object`

- success `condition`

- error `value` Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.

- error code `value` Stripe's machine-readable code, e.g. `card_declined`, `resource_missing`.

- decline code `value` Why the bank refused, e.g. `insufficient_funds`. Only set on a declined card.

| `stripe checkout` |
| --- |
| `payment page` |
| `pay url` |
| `redirect` |
| `hosted payment` |

### Version history

Introduced in [`v15.0.0`](https://docs.rual.nl/core-versions/150000).

### Service documentation