The stripe-prepared product purchase function enables the use of existing SKUs from a Stripe product, allowing purchases within your flow.

📘

Note

This method does not support metadata.

Prerequisites

Enabling Checkout

To use the Checkout client-only integration, enable it in the Stripe Checkout settings.

One-time purchase products

Khoros Flow supports only one-time purchase products. When creating a new Stripe product, ensure you have selected the correct option.

Usage example

async payload => { 
  const url = await payments.preparedPurchase.stripe({
    key: 'your_stripe_publishable_key',
    locale: 'nl',
    collectAddress: true,
    submitType: 'donate',
    items: [
      {
        sku: 'sku_of_your_product', quantity: 1
      },
      {
        sku: 'sku_of_your_another_product', quantity: 3
      }
      ],
    onSuccess: {
      eventName: 'bought',
      params: [
        new Param('category', 'clothes')
        ]
    },
    onFailure: {
      eventName: 'not bought',
      params: [
        new Param('category', 'clothes')
        ]
    }
  })
  
  const buttons = new Buttons('Purchase my items')
  buttons.addButton(new Button({
    label: 'Click to purchase',
    type: 'payment',
    value: url
  }))

  const message = new Message(`Purchase items here ${url}`)
  message.addResponse(buttons)

  return message
}

Properties

Success and Failure params

You can include onSuccess and onFailure configuration, that will be used in corresponding situations.

Items

Multiple selections are based on the number of items being purchased. Each individual item should contain sku and quantity properties.

Properties