Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Parseaddr Com Checkout API
version: 1.0.0
description: 'Operations tagged Checkout across 2 of this provider''s published API definitions: api-parseaddr-com-openapi.json, parseaddr-com-openapi.json. Each path carries the servers of the definition it was published in.'
security:
- ApiKeyBearer: []
tags:
- name: Checkout
paths:
/v1/checkout:
post:
summary: Create Checkout
description: 'Create a Stripe Checkout Session for a paid plan and return its URL. The matching
webhook issues or upgrades the key once the session completes.'
operationId: create_checkout_v1_checkout_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Checkout
/v1/checkout/key:
get:
summary: Checkout Key
description: 'Reveal the API key issued for a completed Checkout session, so a brand-new buyer — who paid
without ever holding a free key to paste — can retrieve it on the success page. Guards:
- the session must be a real, PAID, completed session on our own Stripe account, and
- we only ever return that session''s own linked customer''s key.
Returns {"status": "pending"} (not an error) when the async webhook hasn''t issued the key yet:
Stripe''s success redirect can beat its own webhook by a few seconds, so the page polls.'
operationId: checkout_key_v1_checkout_key_get
parameters:
- name: session_id
in: query
required: true
schema:
type: string
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Checkout
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
CheckoutIn:
properties:
plan:
type: string
maxLength: 32
title: Plan
examples:
- pro
email:
anyOf:
- type: string
maxLength: 254
- type: 'null'
title: Email
description: Prefill the Checkout email.
type: object
required:
- plan
title: CheckoutIn
securitySchemes:
ApiKeyBearer:
type: http
scheme: bearer
description: 'Your parseaddr API key as a Bearer token (Authorization: Bearer pa_live_…).'
x-refined-from:
- api-parseaddr-com-openapi.json
- parseaddr-com-openapi.json