The config object is passed as the second argument to new plenigo.Checkout(purchaseId, config).
var config = { elementId: "plenigoCheckout" };
new plenigo.Checkout(purchaseId, config).start();
Configuration attributes
Attribute | Required | Type | Example | Description |
|---|---|---|---|---|
| ✅ |
|
| The |
|
|
| After returning from an external payment page (PayPal, Stripe, AmazonPay, PayOne, etc.), the SDK uses | |
|
|
| 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 | |
|
|
| If you use PayOne as your PSP, you can restrict which card types are shown. See the PayOne documentation for valid values. | |
|
|
| Hides specific salutation options from address forms. Available values: | |
|
|
| Enables additional input fields in address forms. Supported keys: | |
|
|
| Full | |
|
|
| Sets the | |
|
|
| ⚠️ Legacy checkout only. Overrides the checkout design variant. Has no effect in the current SDK. |
⚠️ Deprecated:
checkoutDesignIdonly 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.
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"
});