Sendpaper

Your agent sends real postcards and letters. You approve; we print and mail.

Should I use this

Quality & Safety

A
Description quality
97%
Schema completeness
88%
Naming quality
97%
Poisoning risk
100%
Permission match
100%
Protocol compliance
100%

Based on automated analysis of tool definitions and protocol compliance.

Context Cost

~7,315Tokens (tool definitions)
~14.3 KBTypical response size
Significant attention impact (5.71% of 128k context)

This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.

Install

One-Click Install

Add this to your `claude_desktop_config.json` file:

{
  "mcpServers": {
    "sendpaper": {
      "url": "https://sendmypaper.com/mcp"
    }
  }
}

Remote endpoints

https://sendmypaper.com/mcpstreamable-http

What it can do

Tool inventory

Tools (6)

🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢get_pricing

List mail products and prices (USD, printing + USPS First-Class postage included, US addresses only).

Input Schema

{
  "type": "object",
  "properties": {}
}

Output Schema

{
  "type": "object",
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cents": {
            "type": "number"
          },
          "price": {
            "type": "string",
            "description": "Display price, e.g. $2.99"
          }
        },
        "required": [
          "id",
          "name",
          "cents",
          "price"
        ],
        "additionalProperties": {}
      }
    },
    "payment": {
      "type": "object",
      "properties": {
        "options": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "currency": {
          "type": "string"
        },
        "stripe_network_id": {
          "description": "Scope Stripe shared payment tokens to this network id",
          "type": "string"
        }
      },
      "required": [
        "options",
        "currency"
      ],
      "additionalProperties": {}
    },
    "first_order_discount": {
      "type": "object",
      "properties": {
        "percent": {
          "type": "number"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "percent",
        "description"
      ],
      "additionalProperties": false,
      "description": "Current first-order discount (0 when none)"
    },
    "letter_photo": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "description"
      ],
      "additionalProperties": false,
      "description": "Surcharge for a letter printed in color (a photo, or a PDF with color on)"
    },
    "express": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "description"
      ],
      "additionalProperties": false,
      "description": "Surcharge for express delivery"
    },
    "pdf_letters": {
      "type": "object",
      "properties": {
        "max_pages": {
          "type": "number"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "max_pages",
        "description"
      ],
      "additionalProperties": false,
      "description": "Mailing your own PDF as a letter"
    }
  },
  "required": [
    "products",
    "payment",
    "first_order_discount",
    "letter_photo",
    "express",
    "pdf_letters"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}
🟡create_postcard(size, to, from, customer_email, idempotency_key, ...)

Create a postcard order (4x6, 6x9 or 6x11) and get a payment link. Front layouts: a big headline on a color, one photo, a photo with a caption, or a collage of 2-4 photos; the back carries the message (handwriting, serif or sans) and addresses. Set express for USPS Priority Mail (2-3 days, tracked). Mails only after the user pays.

Input Schema

{
  "type": "object",
  "properties": {
    "size": {
      "default": "4x6",
      "description": "Postcard size: 4x6, 6x9 or 6x11 (see get_pricing for prices)",
      "type": "string",
      "enum": [
        "4x6",
        "6x9",
        "6x11"
      ]
    },
    "to": {
      "description": "Recipient's US mailing address (or use recipients for several people)",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "Recipient or sender full name"
        },
        "company": {
          "description": "Company name, printed under the person's name",
          "type": "string",
          "maxLength": 60
        },
        "line1": {
          "type": "string",
          "minLength": 3,
          "maxLength": 64,
          "description": "Street address"
        },
        "line2": {
          "description": "Apartment, suite, unit",
          "type": "string",
          "maxLength": 64
        },
        "city": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40,
          "description": "City"
        },
        "state": {
          "description": "Two-letter US state code, e.g. NY",
          "type": "string"
        },
        "zip": {
          "type": "string",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "description": "5-digit US ZIP code, or ZIP+4"
        }
      },
      "required": [
        "name",
        "line1",
        "city",
        "state",
        "zip"
      ]
    },
    "from": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "Recipient or sender full name"
        },
        "company": {
          "description": "Company name, printed under the person's name",
          "type": "string",
          "maxLength": 60
        },
        "line1": {
          "type": "string",
          "minLength": 3,
          "maxLength": 64,
          "description": "Street address"
        },
        "line2": {
          "description": "Apartment, suite, unit",
          "type": "string",
          "maxLength": 64
        },
        "city": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40,
          "description": "City"
        },
        "state": {
          "description": "Two-letter US state code, e.g. NY",
          "type": "string"
        },
        "zip": {
          "type": "string",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "description": "5-digit US ZIP code, or ZIP+4"
        }
      },
      "required": [
        "name",
        "line1",
        "city",
        "state",
        "zip"
      ],
      "description": "Return address; printed on the mail piece"
    },
    "customer_email": {
      "description": "Where to send the receipt and status updates",
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "idempotency_key": {
      "description": "Any unique string; retrying with the same key returns the original order instead of creating a duplicate",
      "type": "string",
      "maxLength": 120
    },
    "express": {
      "default": false,
      "description": "Send by express (USPS Priority Mail, usually 2–3 days, with tracking) for an extra charge; see get_pricing. Not available with certified.",
      "type": "boolean"
    },
    "content": {
      "type": "object",
      "properties": {
        "layout": {
          "description": "Front layout: headline (big text on a color), photo (one full-bleed photo), photo_caption (photo with a caption band), collage (2-4 photos). Inferred from the fields when omitted.",
          "type": "string",
          "enum": [
            "headline",
            "photo",
            "photo_caption",
            "collage"
          ]
        },
        "front_image_url": {
          "description": "https URL of a photo or design for the front (JPG or PNG); for photo and photo_caption",
          "type": "string",
          "maxLength": 2000
        },
        "front_images": {
          "description": "Collage: 2 to 4 https photo URLs, laid out in a grid",
          "minItems": 2,
          "maxItems": 4,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 2000
          }
        },
        "caption": {
          "description": "photo_caption: short text over a band at the bottom of the photo",
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "front_headline": {
          "description": "headline layout: big text for the front, e.g. 'Happy birthday, Sam!'",
          "type": "string",
          "maxLength": 60
        },
        "front_theme": {
          "default": "ink",
          "description": "headline layout: color theme (ink, sky, sunset, forest, rose, sand, night, mint)",
          "type": "string",
          "enum": [
            "ink",
            "sky",
            "sunset",
            "forest",
            "rose",
            "sand",
            "night",
            "mint"
          ]
        },
        "headline_font": {
          "default": "serif",
          "description": "Font for the headline or caption: serif, sans or script (handwritten)",
          "type": "string",
          "enum": [
            "serif",
            "sans",
            "script"
          ]
        },
        "message": {
          "type": "string",
          "minLength": 1,
          "maxLength": 600,
          "description": "The message on the back"
        },
        "message_font": {
          "default": "handwriting",
          "description": "Font for the message on the back",
          "type": "string",
          "enum": [
            "handwriting",
            "serif",
            "sans"
          ]
        }
      },
      "required": [
        "message"
      ],
      "description": "Front (an image URL or a headline) and the message on the back"
    },
    "recipients": {
      "minItems": 2,
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "description": "Recipient or sender full name"
          },
          "company": {
            "description": "Company name, printed under the person's name",
            "type": "string",
            "maxLength": 60
          },
          "line1": {
            "type": "string",
            "minLength": 3,
            "maxLength": 64,
            "description": "Street address"
          },
          "line2": {
            "description": "Apartment, suite, unit",
            "type": "string",
            "maxLength": 64
          },
          "city": {
            "type": "string",
            "minLength": 2,
            "maxLength": 40,
            "description": "City"
          },
          "state": {
            "description": "Two-letter US state code, e.g. NY",
            "type": "string"
          },
          "zip": {
            "type": "string",
            "pattern": "^\\d{5}(-\\d{4})?$",
            "description": "5-digit US ZIP code, or ZIP+4"
          }
        },
        "required": [
          "name",
          "line1",
          "city",
          "state",
          "zip"
        ]
      },
      "description": "Send the same piece to several people: 2-25 US addresses, used INSTEAD of to. Each gets their own order and tracking; one payment covers all."
    }
  },
  "required": [
    "from",
    "content"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order id, ord_…"
    },
    "object": {
      "type": "string",
      "enum": [
        "postcard",
        "letter"
      ]
    },
    "product": {
      "type": "string",
      "description": "Product id, e.g. postcard_4x6 or letter_certified"
    },
    "product_name": {
      "type": "string"
    },
    "certified": {
      "type": "string",
      "description": "none, certified or certified_return_receipt"
    },
    "status": {
      "type": "string",
      "description": "awaiting_payment, paid, printing, mailed, cancelled or refunded"
    },
    "status_detail": {
      "type": "string",
      "description": "Plain-English status to show the user"
    },
    "price": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "display": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "currency",
        "display"
      ],
      "additionalProperties": false
    },
    "checkout_url": {
      "description": "Where the user pays; null once paid or cancelled",
      "type": [
        "string",
        "null"
      ]
    },
    "order_url": {
      "type": "string",
      "description": "Order status page"
    },
    "preview_url": {
      "type": "string",
      "description": "Exact print preview"
    },
    "preview_image_url": {
      "description": "PNG picture of the piece (postcard front and back, or the letter's first page) to show the user",
      "type": "string"
    },
    "tracking": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "number",
            "url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "USPS tracking, for Certified Mail once printed"
    },
    "discount": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "display": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "display",
            "reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "First-order discount, already taken off price; null when none applies"
    },
    "batch": {
      "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "count": {
          "type": "number",
          "description": "How many recipients (one order each)"
        },
        "url": {
          "type": "string",
          "description": "Group page listing every recipient"
        },
        "checkout_url": {
          "description": "One payment link for every unpaid order in the group",
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "currency",
            "display"
          ],
          "additionalProperties": false,
          "description": "Total for the whole group"
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "amount_cents": {
                  "type": "number"
                },
                "display": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "amount_cents",
                "display",
                "reason"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "count",
        "url",
        "checkout_url",
        "price",
        "discount"
      ],
      "additionalProperties": false
    },
    "orders": {
      "description": "Every order in the group, when created with recipients",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "order_url": {
            "type": "string"
          },
          "preview_url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "order_url",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "object",
    "product",
    "product_name",
    "certified",
    "status",
    "status_detail",
    "price",
    "checkout_url",
    "order_url",
    "preview_url",
    "tracking",
    "discount"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {}
}
🟡create_letter(to, from, customer_email, idempotency_key, content, ...)

Create a printed letter order (8.5x11, mailed in a #10 envelope) and get a payment link. Either write it (content.body, up to ~3 pages, optional photo) or mail the user's own PDF (content.pdf_url, a public https link, up to 6 pages). Set certified to "certified" for USPS Certified Mail with tracking and proof of delivery, or "certified_return_receipt" to add the recipient's signature; use these when the user needs proof (tax notice replies, lease notices, disputes, demand letters). Or set express for USPS Priority Mail (not with certified). Prices: get_pricing. Mails only after the user pays.

Input Schema

{
  "type": "object",
  "properties": {
    "to": {
      "description": "Recipient's US mailing address (or use recipients for several people)",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "Recipient or sender full name"
        },
        "company": {
          "description": "Company name, printed under the person's name",
          "type": "string",
          "maxLength": 60
        },
        "line1": {
          "type": "string",
          "minLength": 3,
          "maxLength": 64,
          "description": "Street address"
        },
        "line2": {
          "description": "Apartment, suite, unit",
          "type": "string",
          "maxLength": 64
        },
        "city": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40,
          "description": "City"
        },
        "state": {
          "description": "Two-letter US state code, e.g. NY",
          "type": "string"
        },
        "zip": {
          "type": "string",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "description": "5-digit US ZIP code, or ZIP+4"
        }
      },
      "required": [
        "name",
        "line1",
        "city",
        "state",
        "zip"
      ]
    },
    "from": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "Recipient or sender full name"
        },
        "company": {
          "description": "Company name, printed under the person's name",
          "type": "string",
          "maxLength": 60
        },
        "line1": {
          "type": "string",
          "minLength": 3,
          "maxLength": 64,
          "description": "Street address"
        },
        "line2": {
          "description": "Apartment, suite, unit",
          "type": "string",
          "maxLength": 64
        },
        "city": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40,
          "description": "City"
        },
        "state": {
          "description": "Two-letter US state code, e.g. NY",
          "type": "string"
        },
        "zip": {
          "type": "string",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "description": "5-digit US ZIP code, or ZIP+4"
        }
      },
      "required": [
        "name",
        "line1",
        "city",
        "state",
        "zip"
      ],
      "description": "Return address; printed on the mail piece"
    },
    "customer_email": {
      "description": "Where to send the receipt and status updates",
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "idempotency_key": {
      "description": "Any unique string; retrying with the same key returns the original order instead of creating a duplicate",
      "type": "string",
      "maxLength": 120
    },
    "content": {
      "type": "object",
      "properties": {
        "body": {
          "description": "Full letter text. Plain text; blank lines separate paragraphs. Use this OR pdf_url.",
          "type": "string",
          "minLength": 1,
          "maxLength": 9000
        },
        "pdf_url": {
          "description": "Mail your own document instead of body text: a public https link to a PDF (up to 6 pages). Pages are fitted to 8.5×11 and a blank address page is added in front.",
          "type": "string",
          "maxLength": 2000
        },
        "color": {
          "description": "PDF letters only: print in color (costs a little more; see get_pricing). Text letters print in color automatically when they include image_url.",
          "type": "boolean"
        },
        "font": {
          "default": "serif",
          "description": "Typeface for the letter body (text letters)",
          "type": "string",
          "enum": [
            "serif",
            "sans"
          ]
        },
        "image_url": {
          "description": "Text letters only: optional photo printed at the top (https JPG or PNG). A letter with a photo prints in color, for a small surcharge (see get_pricing).",
          "type": "string",
          "maxLength": 2000
        },
        "pdf_pages": {
          "description": "Set by Sendpaper: page count of the PDF",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        }
      },
      "description": "The letter: body text (optionally with a photo) or your own PDF"
    },
    "certified": {
      "default": "none",
      "description": "USPS Certified Mail. \"certified\": tracking number and proof of mailing and delivery. \"certified_return_receipt\": adds the recipient's signature as proof of delivery, which landlords, courts and agencies often require. \"none\": regular First-Class. Prices: get_pricing.",
      "type": "string",
      "enum": [
        "none",
        "certified",
        "certified_return_receipt"
      ]
    },
    "express": {
      "default": false,
      "description": "Send by express (USPS Priority Mail, usually 2–3 days, with tracking) for an extra charge; see get_pricing. Not available with certified.",
      "type": "boolean"
    },
    "recipients": {
      "minItems": 2,
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "description": "Recipient or sender full name"
          },
          "company": {
            "description": "Company name, printed under the person's name",
            "type": "string",
            "maxLength": 60
          },
          "line1": {
            "type": "string",
            "minLength": 3,
            "maxLength": 64,
            "description": "Street address"
          },
          "line2": {
            "description": "Apartment, suite, unit",
            "type": "string",
            "maxLength": 64
          },
          "city": {
            "type": "string",
            "minLength": 2,
            "maxLength": 40,
            "description": "City"
          },
          "state": {
            "description": "Two-letter US state code, e.g. NY",
            "type": "string"
          },
          "zip": {
            "type": "string",
            "pattern": "^\\d{5}(-\\d{4})?$",
            "description": "5-digit US ZIP code, or ZIP+4"
          }
        },
        "required": [
          "name",
          "line1",
          "city",
          "state",
          "zip"
        ]
      },
      "description": "Send the same piece to several people: 2-25 US addresses, used INSTEAD of to. Each gets their own order and tracking; one payment covers all."
    }
  },
  "required": [
    "from",
    "content"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order id, ord_…"
    },
    "object": {
      "type": "string",
      "enum": [
        "postcard",
        "letter"
      ]
    },
    "product": {
      "type": "string",
      "description": "Product id, e.g. postcard_4x6 or letter_certified"
    },
    "product_name": {
      "type": "string"
    },
    "certified": {
      "type": "string",
      "description": "none, certified or certified_return_receipt"
    },
    "status": {
      "type": "string",
      "description": "awaiting_payment, paid, printing, mailed, cancelled or refunded"
    },
    "status_detail": {
      "type": "string",
      "description": "Plain-English status to show the user"
    },
    "price": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "display": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "currency",
        "display"
      ],
      "additionalProperties": false
    },
    "checkout_url": {
      "description": "Where the user pays; null once paid or cancelled",
      "type": [
        "string",
        "null"
      ]
    },
    "order_url": {
      "type": "string",
      "description": "Order status page"
    },
    "preview_url": {
      "type": "string",
      "description": "Exact print preview"
    },
    "preview_image_url": {
      "description": "PNG picture of the piece (postcard front and back, or the letter's first page) to show the user",
      "type": "string"
    },
    "tracking": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "number",
            "url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "USPS tracking, for Certified Mail once printed"
    },
    "discount": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "display": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "display",
            "reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "First-order discount, already taken off price; null when none applies"
    },
    "batch": {
      "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "count": {
          "type": "number",
          "description": "How many recipients (one order each)"
        },
        "url": {
          "type": "string",
          "description": "Group page listing every recipient"
        },
        "checkout_url": {
          "description": "One payment link for every unpaid order in the group",
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "currency",
            "display"
          ],
          "additionalProperties": false,
          "description": "Total for the whole group"
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "amount_cents": {
                  "type": "number"
                },
                "display": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "amount_cents",
                "display",
                "reason"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "count",
        "url",
        "checkout_url",
        "price",
        "discount"
      ],
      "additionalProperties": false
    },
    "orders": {
      "description": "Every order in the group, when created with recipients",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "order_url": {
            "type": "string"
          },
          "preview_url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "order_url",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "object",
    "product",
    "product_name",
    "certified",
    "status",
    "status_detail",
    "price",
    "checkout_url",
    "order_url",
    "preview_url",
    "tracking",
    "discount"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {}
}
🔴pay_order(order_id, shared_payment_token)

Pay for an unpaid order with a Stripe shared payment token (spt_…) the user approved, scoped to at least the order amount in USD. For an order created with recipients, this pays for the whole group at once (scope the token to batch.price). On success the order is paid and goes to print. Use only after the user approved the purchase.

Input Schema

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "description": "Order id from create_postcard or create_letter, ord_…"
    },
    "shared_payment_token": {
      "type": "string",
      "description": "Stripe shared payment token, spt_…"
    }
  },
  "required": [
    "order_id",
    "shared_payment_token"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order id, ord_…"
    },
    "object": {
      "type": "string",
      "enum": [
        "postcard",
        "letter"
      ]
    },
    "product": {
      "type": "string",
      "description": "Product id, e.g. postcard_4x6 or letter_certified"
    },
    "product_name": {
      "type": "string"
    },
    "certified": {
      "type": "string",
      "description": "none, certified or certified_return_receipt"
    },
    "status": {
      "type": "string",
      "description": "awaiting_payment, paid, printing, mailed, cancelled or refunded"
    },
    "status_detail": {
      "type": "string",
      "description": "Plain-English status to show the user"
    },
    "price": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "display": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "currency",
        "display"
      ],
      "additionalProperties": false
    },
    "checkout_url": {
      "description": "Where the user pays; null once paid or cancelled",
      "type": [
        "string",
        "null"
      ]
    },
    "order_url": {
      "type": "string",
      "description": "Order status page"
    },
    "preview_url": {
      "type": "string",
      "description": "Exact print preview"
    },
    "preview_image_url": {
      "description": "PNG picture of the piece (postcard front and back, or the letter's first page) to show the user",
      "type": "string"
    },
    "tracking": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "number",
            "url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "USPS tracking, for Certified Mail once printed"
    },
    "discount": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "display": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "display",
            "reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "First-order discount, already taken off price; null when none applies"
    },
    "batch": {
      "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "count": {
          "type": "number",
          "description": "How many recipients (one order each)"
        },
        "url": {
          "type": "string",
          "description": "Group page listing every recipient"
        },
        "checkout_url": {
          "description": "One payment link for every unpaid order in the group",
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "currency",
            "display"
          ],
          "additionalProperties": false,
          "description": "Total for the whole group"
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "amount_cents": {
                  "type": "number"
                },
                "display": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "amount_cents",
                "display",
                "reason"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "count",
        "url",
        "checkout_url",
        "price",
        "discount"
      ],
      "additionalProperties": false
    },
    "orders": {
      "description": "Every order in the group, when created with recipients",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "order_url": {
            "type": "string"
          },
          "preview_url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "order_url",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "object",
    "product",
    "product_name",
    "certified",
    "status",
    "status_detail",
    "price",
    "checkout_url",
    "order_url",
    "preview_url",
    "tracking",
    "discount"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {}
}
🟢get_order(order_id)

Get the status of a postcard or letter order by id (ord_...).

Input Schema

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "description": "Order id, ord_…"
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order id, ord_…"
    },
    "object": {
      "type": "string",
      "enum": [
        "postcard",
        "letter"
      ]
    },
    "product": {
      "type": "string",
      "description": "Product id, e.g. postcard_4x6 or letter_certified"
    },
    "product_name": {
      "type": "string"
    },
    "certified": {
      "type": "string",
      "description": "none, certified or certified_return_receipt"
    },
    "status": {
      "type": "string",
      "description": "awaiting_payment, paid, printing, mailed, cancelled or refunded"
    },
    "status_detail": {
      "type": "string",
      "description": "Plain-English status to show the user"
    },
    "price": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "display": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "currency",
        "display"
      ],
      "additionalProperties": false
    },
    "checkout_url": {
      "description": "Where the user pays; null once paid or cancelled",
      "type": [
        "string",
        "null"
      ]
    },
    "order_url": {
      "type": "string",
      "description": "Order status page"
    },
    "preview_url": {
      "type": "string",
      "description": "Exact print preview"
    },
    "preview_image_url": {
      "description": "PNG picture of the piece (postcard front and back, or the letter's first page) to show the user",
      "type": "string"
    },
    "tracking": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "number",
            "url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "USPS tracking, for Certified Mail once printed"
    },
    "discount": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "display": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "display",
            "reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "First-order discount, already taken off price; null when none applies"
    },
    "batch": {
      "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "count": {
          "type": "number",
          "description": "How many recipients (one order each)"
        },
        "url": {
          "type": "string",
          "description": "Group page listing every recipient"
        },
        "checkout_url": {
          "description": "One payment link for every unpaid order in the group",
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "currency",
            "display"
          ],
          "additionalProperties": false,
          "description": "Total for the whole group"
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "amount_cents": {
                  "type": "number"
                },
                "display": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "amount_cents",
                "display",
                "reason"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "count",
        "url",
        "checkout_url",
        "price",
        "discount"
      ],
      "additionalProperties": false
    },
    "orders": {
      "description": "Every order in the group, when created with recipients",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "order_url": {
            "type": "string"
          },
          "preview_url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "order_url",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "object",
    "product",
    "product_name",
    "certified",
    "status",
    "status_detail",
    "price",
    "checkout_url",
    "order_url",
    "preview_url",
    "tracking",
    "discount"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {}
}
🔴cancel_order(order_id)

Cancel an order that has not been paid yet. Paid orders can be cancelled by emailing support before they are printed.

Input Schema

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "description": "Order id, ord_…"
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order id, ord_…"
    },
    "object": {
      "type": "string",
      "enum": [
        "postcard",
        "letter"
      ]
    },
    "product": {
      "type": "string",
      "description": "Product id, e.g. postcard_4x6 or letter_certified"
    },
    "product_name": {
      "type": "string"
    },
    "certified": {
      "type": "string",
      "description": "none, certified or certified_return_receipt"
    },
    "status": {
      "type": "string",
      "description": "awaiting_payment, paid, printing, mailed, cancelled or refunded"
    },
    "status_detail": {
      "type": "string",
      "description": "Plain-English status to show the user"
    },
    "price": {
      "type": "object",
      "properties": {
        "amount_cents": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "display": {
          "type": "string"
        }
      },
      "required": [
        "amount_cents",
        "currency",
        "display"
      ],
      "additionalProperties": false
    },
    "checkout_url": {
      "description": "Where the user pays; null once paid or cancelled",
      "type": [
        "string",
        "null"
      ]
    },
    "order_url": {
      "type": "string",
      "description": "Order status page"
    },
    "preview_url": {
      "type": "string",
      "description": "Exact print preview"
    },
    "preview_image_url": {
      "description": "PNG picture of the piece (postcard front and back, or the letter's first page) to show the user",
      "type": "string"
    },
    "tracking": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "number",
            "url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "USPS tracking, for Certified Mail once printed"
    },
    "discount": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "display": {
              "type": "string"
            },
            "reason": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "display",
            "reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "First-order discount, already taken off price; null when none applies"
    },
    "batch": {
      "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "count": {
          "type": "number",
          "description": "How many recipients (one order each)"
        },
        "url": {
          "type": "string",
          "description": "Group page listing every recipient"
        },
        "checkout_url": {
          "description": "One payment link for every unpaid order in the group",
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "object",
          "properties": {
            "amount_cents": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          },
          "required": [
            "amount_cents",
            "currency",
            "display"
          ],
          "additionalProperties": false,
          "description": "Total for the whole group"
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "amount_cents": {
                  "type": "number"
                },
                "display": {
                  "type": "string"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "amount_cents",
                "display",
                "reason"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "count",
        "url",
        "checkout_url",
        "price",
        "discount"
      ],
      "additionalProperties": false
    },
    "orders": {
      "description": "Every order in the group, when created with recipients",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "order_url": {
            "type": "string"
          },
          "preview_url": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "to",
          "order_url",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "object",
    "product",
    "product_name",
    "certified",
    "status",
    "status_detail",
    "price",
    "checkout_url",
    "order_url",
    "preview_url",
    "tracking",
    "discount"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {}
}

Community

Rate this Server

Evidence

Recent observations

verifiedversion not recorded6 tools
verifiedversion not recorded6 tools