Start a credit purchase

Creates a Stripe Checkout session for a credit pack and returns its URL. The session binds to the key on the request, so the credits land on that key when payment completes; poll GET /api/v1/credits to confirm. An agent can create the session itself and hand its human one URL, which is the only step it cannot take. Returns 503 while self-serve purchase is closed, with the contact path in meta.

post/api/v1/credits/checkout

Request

  • Base URL: https://macfax.com
  • URL: https://macfax.com/api/v1/credits/checkout
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in header X-Api-Key
    • API key in query parameter api_key

Request body

sku'api_250' | 'api_1k' | 'api_5k' required
return_to'/developers' | '/lookup/bulk'

The Macfax page Stripe returns the buyer to. Defaults to /developers.

Response

checkout_url to open in a browser.

Changes

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