Buy one year of rent-receipt access (€4.90, one-shot)

Opens a Stripe Checkout session for the one-shot €4.90 purchase that grants a year of rent-receipt sending.

It is a one-off payment, not a subscription: nothing renews, nothing is trialled, and the window simply lapses. The price is fixed server-side: the client never chooses a Stripe price id.

Redirect the user to checkout_url. Entitlement is granted by the Stripe webhook once the payment settles, so re-read GET /quittance-access after the user comes back to success_url rather than assuming access on return.

Pointless when the plan already includes rent receipts; check GET /quittance-access first.

post/quittance-access/checkout

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/quittance-access/checkout
Auth: HTTP bearer

Request body

success_urlstring uri required

Where Stripe returns the user after a successful payment.

cancel_urlstring uri required

Where Stripe returns the user if they abandon the payment.

payment_method_typesstring[] nullable

Restrict the Stripe payment methods offered. Stripe's defaults apply when omitted.

Example request

{
  "success_url": "https://app.faireplace.com/billing?quittances=ok",
  "cancel_url": "https://app.faireplace.com/billing",
  "payment_method_types": [
    "card"
  ]
}

Response

Checkout session created.

checkout_urlstring uri

Stripe Checkout URL to redirect the user to.

Example response

{
  "checkout_url": "https://checkout.stripe.com/c/pay/cs_test_a1b2c3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.