subscriptions
subscriptions

Create Subscription Checkout

Create a subscription-mode Stripe Checkout Session for a standing order.

The purchase→subscription path (ADR-041): the operator creates the Subscription row first (existing CRUD — the frozen filter/cadence/stages the client agreed to), then mints this recurring payment link to send the buyer. The session threads subscription_id in metadata; on checkout.session.completed the commerce webhook links the Stripe subscription back to this row, stamps the ids, and flips billing_status='active'. Admin-only — same gate as the CRUD.

post/api/v1/subscriptions/{subscription_id}/checkout

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/subscriptions/{subscription_id}/checkout
  • Auth: API key in header X-API-Key

Path parameters

subscription_idstring uuid required

Request body

price_centsinteger required
billing_interval'day' | 'week' | 'month' | 'year'
buyer_emailstring nullable
test_modeboolean
success_urlstring nullable
cancel_urlstring nullable

Response

Successful Response

subscription_idstring uuid required
session_idstring required
checkout_urlstring required

Changes

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