Help

Loyalty Plugin Options

In this guide, you'll learn about the options you can pass to the Loyalty Plugin.

Options Example#

medusa-config.js
module.exports = defineConfig({
  // ...
  plugins: [
    {
      resolve: "@medusajs/loyalty-plugin",
      options: {
        prefix: "GC",
        sections: 3,
      },
    },
  ],
})

All Options#

Option	Description	Required	Default
`prefix`	A string indicating the prefix added to auto-generated gift card codes. For example, setting `prefix` to `GC` generates codes in the format `GC-XXXX-XXXX-XXXX-XXXX`. (Available since v2.17.2)	No	`GIFT`
`sections`	A number indicating how many 4-character sections the generated gift card code contains. For example, setting `sections` to `3` generates codes in the format `GIFT-XXXX-XXXX-XXXX`. (Available since v2.17.2)	No	`4`

Was this page helpful?