---
title: 'Optional Parameters'
url: 'https://manuals.remository.com/payage/the-payage-plugin/optional-parameters'
markdown: 'https://manuals.remository.com/payage/the-payage-plugin/optional-parameters.md'
date: '2026-11-14'
description: 'As a minimum, you must specify the "product name" (in double quotes), the price, and the currency, as shown above. There are more optional parameters, which can be specified in any order: Parameter Description -group X An account group. If you don''t specify an account group, all buttons matc…'
taxonomy:
  category:
    - docs
---

[](#) [ edit this page](https://github.com/getgrav/grav-skeleton-rtfm-site/blob/develop/pages/16.the-payage-plugin/02.optional-parameters/docs.md) 

# Optional Parameters

As a minimum, you must specify the "product name" (in double quotes), the price, and the currency, as shown above. There are more optional parameters, which can be specified in any order:

| Parameter | Description |
|---|---|
| `-group X` | An account group. If you don't specify an account group, all buttons matching the currency are shown. |
| `-layout X` | The button layout, where X is a number from 1 to 8 as described below. |
| `-success_url URL` | Species a URL to redirect to if payment is successful. If not specified, the user is returned to the same page. Please see "Beware of the -success\_url parameter", below. |
| `-cancel_url URL` | Species a URL to redirect to if payment is cancelled. If not specified, the user is returned to the same page. |
| `-return_url URL` | The URL to return to immediately after payment. After payment, the plugin needs to return to the same page it was called from, so that it gets control and can show the return message, or redirect to the *success\_url* or *cancel\_url* (if specified). Normally the plugin can return to the correct page automatically, but in some unusual cases it cannot. For example, returning to a specific page of a multi-page Chronoform requires URL parameters, like this: `/chronoform/?chronoform=form2&event=submit` In most cases you won't need to use this parameter. |
| `-min_amount X` | The minimum amount that can be entered in form mode. |
| `-max_amount X` | The maximum amount that can be entered in form mode. |
| `-invoice` | Adds a direct link to your Invoice Request page, if there is one, after a successful payment. |

Some more examples:

```
{payage "red jumper" 34.99 EUR -group 3 -layout 2}

{payage "blue jumper" 36.00 USD -success_url /thank-you -cancel_url /more-offers -layout 2}
```

Older versions used a slightly different syntax where parameter 4 was the account group, and parameter 5 was the layout option. This still works but is deprecated and may not work in future releases. If you are still using the old syntax, please change your calls to use the -group and -layout parameters.

 [ ](https://manuals.remository.com/payage/the-payage-plugin/the-simplest-example) [](https://manuals.remository.com/payage/the-payage-plugin/the-layout-option)

---

## Navigation

- Parent: [The Payage Plugin](https://manuals.remository.com/payage/the-payage-plugin.md)
- Previous: [The Simplest Example](https://manuals.remository.com/payage/the-payage-plugin/the-simplest-example.md)
- Next: [The Layout Option](https://manuals.remository.com/payage/the-payage-plugin/the-layout-option.md)