Account

Generate a checkout link

Returns a Stripe checkout URL for the requested plan. Send the URL to the user to pay in a browser; poll /api/payments/status to confirm. Naturally idempotent: no record is created; retries return the same payment link.

post/api/payments/checkout-link

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/payments/checkout-link
  • Auth: one of:
    • API key in header X-ClearList-API-Key
    • OAuth 2 (authorization code, authorization URL https://clearlist.me/oauth/authorize, token URL https://clearlist.me/api/oauth/token, scopes: write)

Request body

plan'sale_pass' | 'big_move' | 'move_extension' | 'garage_extension' required

Response

Checkout link — or already_paid. When the account already holds an equal-or-higher active plan, the 200 carries data.already_paid: true with plan, expires_at and a human-readable message instead of a link; do NOT send the user to checkout in that case. Upgrades (sale_pass → big_move) still return a link.

successboolean

Changes

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