Get a Premier Letters API key without the user copying one by hand. Pass the user's email and your name; we email them a link to approve (they can sign up from it if they have no account). Then call check_connection with the returned request_id and poll_secret every 10-30 seconds until it returns the api_key (returned once). Show the returned user_code to the user so they can match it on the approval page. No account or key needed to call this.
輸入參數modeemail必填agent_name必填
Check whether the user approved a connect_account request. Returns status pending, denied, expired or claimed, or, exactly once, status approved with the api_key. Poll every 10-30 seconds.
輸入參數request_id必填poll_secret必填
Get a live price quote for a Premier Letters order. Pass char_count (or letter_count for a rough estimate) plus optional mailing_option and paper_type to get a per-piece and total price, in cents. No account needed. Orders under 5 pieces carry a $0.99 per-piece handling fee (included in total_cents), waived when paid from a prepaid balance. Pass output_mode (printed_bw / printed_color) to quote a printed letter body instead of a pen-written one, and envelope_output_mode to quote a printed envelope.
輸入參數char_countpaper_typeoutput_modeletter_countproduct_typemailing_optionenvelope_output_mode
List available handwriting styles (fonts) for a letter order. Use the returned "id" as options.handwriting_style / handwriting_style when creating an order or previewing.
無需輸入參數。
List the authenticated user's saved letter templates.
輸入參數sortsearchfavorites_only
Verify and standardize a US mailing address via USPS. Use before create_order to catch typos and get the USPS-standardized form.
輸入參數zip必填city必填state必填address_line1必填address_line2
Render a preview of a handwritten letter (as an SVG image) and get its price, before creating an order. Does not save anything.
輸入參數message必填recipientproduct_typehandwriting_style
Create and pay for a Premier Letters order — a real, handwritten letter mailed via USPS. Requires a Premier Letters API key. Use get_pricing or preview_letter first to confirm the price. For payment, "card_on_file" charges the caller's saved card immediately, "balance" pays from the prepaid account balance (no small-order handling fee; fails with insufficient_balance when short), or "checkout_session" returns a checkout_url for the human to complete payment in a browser. Envelope return address: an explicit no_return_address_ack: true always wins; otherwise a supplied return_address, else the account default. With neither address, set no_return_address_ack: true to send without one.
輸入參數message必填optionspaymentrecipientsskip_invalidreturn_addressidempotency_keyno_return_address_ackreturn_address_partial_ok
Get an order's status, delivery/tracking summary, and per-recipient mail status.
輸入參數order_id必填
List the authenticated user's recent orders.
輸入參數limitstatus
Get the authenticated account's prepaid balance (balance_cents) and the top-up rules: minimum and maximum top-up, bonus tiers and suggested amounts. Orders paid with payment.method "balance" skip the small-order handling fee. Use create_topup_link to add funds.
無需輸入參數。
Create a Stripe Checkout link that adds prepaid credit (plus any bonus tier) to the authenticated account. Give checkout_url to the human to pay in a browser; the balance updates once they pay (check with get_balance). amount_cents must be a whole number between min_cents and max_cents from get_balance.
輸入參數amount_cents必填