---
title: "Checkout Configuration Reference"
slug: "checkout-configuration-reference"
updated: 2026-06-03T13:51:20Z
published: 2026-06-23T10:52:16Z
canonical: "help.frisbii.com/checkout-configuration-reference"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.frisbii.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkout Configuration Reference

The `config` object is passed as the second argument to `new plenigo.Checkout(purchaseId, config)`.

```javascript
var config = { elementId: "plenigoCheckout" };
new plenigo.Checkout(purchaseId, config).start();
```

---

## Configuration attributes

| Attribute | Required | Type | Example | Description |
| --- | --- | --- | --- | --- |
| `elementId` | ✅ | `string` | `"plenigoCheckout"` | The `id` of the HTML element the checkout iframe will be injected into. Must be accessible via `document.getElementById`. |
| `returnUrl` |  | `string` | `"https://example.com/checkout"` | After returning from an external payment page (PayPal, Stripe, AmazonPay, PayOne, etc.), the SDK uses `location.href` by default. Set `returnUrl` to override this. **Maximum 220 characters** including protocol, port, and query parameters. |
| `restartUrl` |  | `string` | `"https://example.com/products"` | If a checkout error occurs, some error pages offer the customer the ability to restart the process. By default this reloads the current page. Set `restartUrl` to redirect to a specific page instead. |
| `supportedCardTypes` |  | `array` | `['V','M','J','A']` | If you use PayOne as your PSP, you can restrict which card types are shown. See the [PayOne documentation](https://docs.payone.com/) for valid values. |
| `filterSalutations` |  | `array` | `['DIVERSE']` | Hides specific salutation options from address forms. Available values: `DIVERSE`, `NONE`, `MR`, `MRS`. |
| `address` |  | `object` | `{ postbox: true, phoneNumber: true }` | Enables additional input fields in address forms. Supported keys: `postbox`, `phoneNumber`. Values must be `boolean`. |
| `customCSS` |  | `string` (URL) | `"https://example.com/assets/checkout.css"` | Full `https://` URL to a custom CSS file that will be loaded last inside the checkout iframe, overriding default styles. CORS headers must allow the Frisbii Media domain. See [Custom CSS](/frisbii-media/docs/custom-css). |
| `title` |  | `string` | `"Checkout"` | Sets the `title` attribute of the checkout iframe for accessibility. Falls back to a default value if not set. |
| `checkoutDesignId` |  | `string` | `"CD_R0MWF7YXMJ13TNDED"` | ⚠️ **Legacy checkout only.** Overrides the checkout design variant. Has no effect in the current SDK. |

> [!CAUTION]
> ⚠️ **Deprecated:** `checkoutDesignId` only applies to the legacy checkout (before May 2025) and has no effect in the current SDK version.

---

## Passing custom data

Any additional properties you add to the config object beyond the attributes above are passed through to the `plenigo.PurchaseSuccess` event as `e.detail.data`. This allows you to carry arbitrary data (e.g. redirect URLs, tracking parameters) through the checkout flow without server-side state.

```javascript
new plenigo.Checkout(purchaseId, {
    elementId: "plenigoCheckout",
    redirectUrl: "https://www.example.com/article.html",
    campaignSource: "newsletter"
}).start();
document.addEventListener("plenigo.PurchaseSuccess", function(e) {
    console.info(e.detail.data.redirectUrl);      // "https://www.example.com/article.html"
    console.info(e.detail.data.campaignSource);   // "newsletter"
});
```

---