Prism/Checkout

Checkout

Take payments with Stripe, Polar, PayPal, NOWPayments or Razorpay, and run coupons, sales and points.

Checkout is set up under Settings > Checkout. Turn on at least one payment gateway and products with a price can be bought from the store.

How a Purchase Works

  1. The customer adds products and addons to the cart, or clicks Buy Now.
  2. Prism works out the price with any sale, coupon and points, then opens the gateway's checkout.
  3. The gateway calls Prism's webhook when the payment completes.
  4. Prism issues a license for each product, or adds the addons to the customer's existing license.
  5. The customer lands on /checkout/success with their downloads.

A product that costs 0, or an order paid entirely with points, skips the gateway. The customer must be signed in to claim it.

General

SettingWhat it does
Store CurrencyThe currency every price is charged in.
Primary GatewayThe gateway used when the customer does not pick one.
Enable Shopping CartLets customers add several products before paying. Off means Buy Now only.
Enable AddonsLets customers buy addons. Off hides them everywhere.
Addons SelectionTickboxes on the product page, or a popup when adding to the cart.
Require Terms of ServiceCustomers must tick a box before paying. Set the Terms of Service URL it links to.

Gateways

Each gateway needs a webhook pointing at Prism so purchases are fulfilled. Use your site address, or your API address if it has its own domain:

https://shop.example.com/api/v1/checkout/webhook/<gateway>
GatewayKeysWebhookEvent
StripeSecret key, publishable key, webhook secret/api/v1/checkout/webhook/stripecheckout.session.completed
PolarAccess token, organization ID, webhook secret/api/v1/checkout/webhook/polarorder.paid
PayPalClient ID, client secret, webhook ID/api/v1/checkout/webhook/paypalCHECKOUT.ORDER.APPROVED
NOWPaymentsAPI key, IPN secretSet for you on each invoicefinished
RazorpayKey ID, key secret, webhook secret/api/v1/checkout/webhook/razorpaypayment_link.paid

Stripe and Polar can open as an Embedded Component Checkout on your site or send the customer to a Hosted Page. The others always use a hosted page. PayPal and NOWPayments have a Sandbox Mode for testing.

Coupons

Under Coupon Codes, add codes customers enter at checkout.

FieldWhat it does
Coupon CodeWhat the customer types. Not case sensitive.
Discount TypeA percentage off, or a fixed amount off the order.
Discount ValueThe percentage or amount.
Minimum SpendThe smallest order it works on. 0 for none.
Maximum UsesHow many times it can be used in total. 0 for unlimited.

Each completed order that used a code counts as one use.

Sales

Sale Events takes a percentage off across the store. Pick a seasonal preset or set your own:

FieldWhat it does
Event NameShown next to sale prices.
Discount PercentageHow much is taken off.
Applies ToAll items, products only or addons only.
Show Site BannerA banner across the top of the store with your text, a badge and a link.

Sale prices show on product cards and pages with the original price crossed out, and are what the customer pays.

Points

With the Points System on, customers earn points on what they buy and spend them for discounts.

SettingWhat it does
Points Earned per $1Points given for each unit of currency spent. Default 100.
Points Needed per $1Points needed to take one unit of currency off. Default 1000.
Points Calculation ModeGlobal rates for everything, or per-product overrides from each product's Points Earned and Points Price.

Customers see their balance in the account menu and choose how many to spend at checkout. Points spent on part of an order earn proportionally fewer points. You can change anyone's balance under Users.