paidlistings.yaml | Meridian handbook

engine-dmo

This feature is part of the DMO bundle (engine-dmo).

config/paidlistings.yaml sets how members pay: the payment provider, and per site the price of each membership tier on sale and whether promotion bookings are paid at checkout or invoiced. Without the file, there is no provider and orders are invoiced by staff.

provider: stripe
stripe:
  secret_key: ${STRIPE_SECRET_KEY}
  webhook_secret: ${STRIPE_WEBHOOK_SECRET}
sites:
  main:
    promotions: checkout
    tiers:
      gold: { amount: "240.00", currency: GBP, months: 12 }

Key	Type	Default	Meaning
`provider`	string	`none`	`stripe` (payment through Stripe Checkout) or `none` (orders are kept for staff to invoice)
`stripe.secret_key`	secret	Required with `stripe`	The Stripe secret key, as `${VAR}`. The variable is read at boot, so `engine-dmo check` needs no secret
`stripe.webhook_secret`	secret	Required with `stripe`	The signing secret of the Stripe webhook endpoint, as `${VAR}`
`stripe.api_base`	string	Stripe’s API	Another base URL, `https` (or `http` on a loopback address, for a test double)
`sites.<site>.promotions`	string	`invoice`	`checkout` (a priced promotion request is paid in the portal; needs a provider) or `invoice`
`sites.<site>.tiers.<tier>.amount`	string	Required	The price as a quoted decimal, such as `"240.00"`
`sites.<site>.tiers.<tier>.currency`	string	The site’s `default_currency`	ISO 4217 code
`sites.<site>.tiers.<tier>.months`	integer	`12`	The period the price buys, 1 to 36

A tier on sale must be declared in memberships.yaml and sold by the site (its site.yaml memberships.tiers). An unset Stripe variable stops the boot with a message naming it. See Paid listings.