pieterpost-com

pieterpost-com API

pieterpost-com API as documented publicly: 6 operations. Contract generated from the documentation by API Evangelist (2026-10-30); not the provider's own document.

GitHub OpenAPI

Operations 6

POST /v1/checkout-links POST /v1/checkout-links #
POST /v1/credits/topups POST /v1/credits/topups #
POST /v1/orders POST /v1/orders #
GET /v1/orders/{orderid} GET /v1/orders/ord_123 #
POST /v1/uploads POST /v1/uploads #
GET /v1/wallet GET /v1/wallet #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/pieterpost-com/openapi/_ae-authored/pieterpost-com-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-post-v1-orders-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-get-v1-orders-orderid-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-post-v1-orders-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-post-v1-credits-topups-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-post-v1-checkout-links-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pieterpost-com/json-schema/pieterpost-com-get-v1-wallet-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/pieterpost-com/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pieterpost-com:pieterpost-com-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pieterpost-com-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: pieterpost-com API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 6 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; pieterpost-com has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 7
    documentation: -1
    pages-with-code: 3
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://pieterpost.com/api
  - https://pieterpost.com/api/docs
  - https://pieterpost.com/api/docs.md
paths:
  /v1/checkout-links:
    post:
      operationId: post_v1_checkout_links
      tags:
      - Checkout Links
      summary: POST /v1/checkout-links
      x-source: https://pieterpost.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CheckoutLinksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://pieterpost.com/v1/checkout-links  -H \"Authorization: Bearer pp_test_your_key_here\"  -H \"Content-Type:\
          \ application/json\"  -d '{\n \"requestType\": \"letter\",\n \"deliveryService\": \"registered\",\n \"senderEmail\": \"sender@example.com\"\
          ,\n \"returnUrl\": \"https://example.com/return\",\n \"letters\": [{\n \"message\": \"Please find the enclosed information.\",\n \"\
          recipient\": {\n \"name\": \"Ada Lovelace\",\n "
  /v1/credits/topups:
    post:
      operationId: post_v1_credits_topups
      tags:
      - Credits
      summary: POST /v1/credits/topups
      x-source: https://pieterpost.com/api/docs
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CreditsTopupsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://pieterpost.com/v1/credits/topups  -H \"Authorization: Bearer pp_test_your_key_here\"  -H \"Content-Type:\
          \ application/json\"  -H \"Idempotency-Key: first-five-minutes-topup\"  -d '{\n \"amountCents\": 2500,\n \"currency\": \"eur\",\n \"\
          metadata\": {\n \"source\": \"billing-settings\"\n },\n \"returnUrl\": \"https://example.com/topups/return\"\n}' Response {\n \"amountCents\"\
          : 2500,\n \"checkoutUrl\": null,\n \"cre"
  /v1/orders:
    post:
      operationId: post_v1_orders
      tags:
      - Orders
      summary: POST /v1/orders
      x-source: https://pieterpost.com/api/docs.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1OrdersRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1OrdersResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://pieterpost.com/v1/orders  -H \"Authorization: Bearer pp_test_your_key_here\"  -H \"Content-Type: application/json\"\
          \  -H \"Idempotency-Key: first-five-minutes-direct-send\"  -d '{\n  \"letters\": [\n    {\n      \"message\": \"This direct-send letter\
          \ is paid from wallet credits.\",\n      \"recipient\": {\n        \"city\": \"Springfield\",\n        \"country\": \"United States\"\
          ,\n        \"name\": \"Pieter "
  /v1/orders/{orderid}:
    get:
      operationId: get_v1_orders_orderid
      tags:
      - Orders
      summary: GET /v1/orders/ord_123
      x-source: https://pieterpost.com/api/docs.md
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: deliveryLimit
        in: query
        required: false
        schema:
          type: string
      - name: deliveryOffset
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1OrdersOrderidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://pieterpost.com/v1/orders/ord_123?deliveryOffset=0&deliveryLimit=25" -H "Authorization: Bearer pp_live_your_key_here"

          ```'
        collapsed_from: 2 example path(s) differing only at orderId
  /v1/uploads:
    post:
      operationId: post_v1_uploads
      tags:
      - Uploads
      summary: POST /v1/uploads
      x-source: https://pieterpost.com/api/docs.md
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1UploadsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://pieterpost.com/v1/uploads  -H "Authorization: Bearer pp_test_your_key_here"  -F "kind=postcard-image"  -F
          "file=@front.jpg"

          ```'
  /v1/wallet:
    get:
      operationId: get_v1_wallet
      tags:
      - Wallet
      summary: GET /v1/wallet
      x-source: https://pieterpost.com/api/docs.md
      parameters:
      - name: currency
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WalletResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://pieterpost.com/v1/wallet?currency=eur  -H "Authorization: Bearer pp_test_your_key_here"

          ```'
components:
  schemas:
    PostV1CheckoutLinksRequest:
      type: object
      properties:
        requestType:
          type: string
        deliveryService:
          type: string
        senderEmail:
          type: string
        returnUrl:
          type: string
        letters:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              recipient:
                type: object
                properties:
                  name:
                    type: string
                  streetAddress:
                    type: string
                  postalCode:
                    type: string
                  city:
                    type: string
                  country:
                    type: string
    PostV1CreditsTopupsResponse:
      type: object
      properties:
        amountCents:
          type: integer
        checkoutUrl:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        currency:
          type: string
        paidAt:
          type: string
          format: date-time
        status:
          type: string
        testMode:
          type: boolean
        topupId:
          type: string
        updatedAt:
          type: string
          format: date-time
        wallet:
          type: object
          properties:
            balanceCents:
              type: integer
            currency:
              type: string
            mode:
              type: string
    PostV1OrdersRequest:
      type: object
      properties:
        letters:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              recipient:
                type: object
                properties:
                  city:
                    type: string
                  country:
                    type: string
                  name:
                    type: string
                  postalCode:
                    type: string
                  state:
                    type: string
                  streetAddress:
                    type: string
        locale:
          type: string
        metadata:
          type: object
          properties:
            campaign:
              type: string
        requestType:
          type: string
        senderEmail:
          type: string
    PostV1OrdersResponse:
      type: object
      properties:
        amountCents:
          type: integer
        billingMode:
          type: string
        checkoutUrl:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        currency:
          type: string
        error:
          type:
          - string
          - 'null'
        expiresAt:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        fulfilledAt:
          type: string
          format: date-time
        metadata:
          type: object
          properties:
            campaign:
              type: string
        orderId:
          type: string
        orderRef:
          type: string
        paidAt:
          type: string
          format: date-time
        paymentReference:
          type: string
        recipientCount:
          type: integer
        requestType:
          type: string
        senderEmail:
          type: string
        status:
          type: string
        testMode:
          type: boolean
        updatedAt:
          type: string
          format: date-time
        wallet:
          type: object
          properties:
            balanceCents:
              type: integer
            currency:
              type: string
            mode:
              type: string
    GetV1OrdersOrderidResponse:
      type: object
      properties:
        orderId:
          type: string
        orderRef:
          type: string
        recipientCount:
          type: integer
        status:
          type: string
        testMode:
          type: boolean
        delivery:
          type: object
          properties:
            availability:
              type: string
            items:
              type: array
              items:
                type: object
                properties:
                  deliveredAt:
                    type:
                    - string
                    - 'null'
                  deliveryService:
                    type: string
                  estimatedDeliveryFrom:
                    type: string
                    format: date
                  estimatedDeliveryTo:
                    type: string
                    format: date
                  recipientIndex:
                    type: integer
                  status:
                    type: string
                  trackingNumber:
                    type: string
                  trackingUrl:
                    type: string
                  updatedAt:
                    type: string
                    format: date-time
            nextOffset:
              type:
              - string
              - 'null'
            recipientCount:
              type: integer
            statusPageUrl:
              type: string
            total:
              type: integer
    PostV1UploadsResponse:
      type: object
      properties:
        assetId:
          type: string
        contentType:
          type: string
        kind:
          type: string
        name:
          type: string
        originalName:
          type: string
        publicUrl:
          type: string
        size:
          type: integer
    GetV1WalletResponse:
      type: object
      properties:
        accountId:
          type: string
        approvalStatus:
          type: string
        approvedForDirectSend:
          type: boolean
        creditsEnabled:
          type: boolean
        hostedApiEnabled:
          type: boolean
        liveEnabled:
          type: boolean
        wallet:
          type: object
          properties:
            balanceCents:
              type: integer
            currency:
              type: string
            mode:
              type: string
            updatedAt:
              type: string
              format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Checkout Links
- name: Credits
- name: Orders
- name: Uploads
- name: Wallet