Review the PDF, current total and mailing requirements before approval.

get/v1/drafts/{id}/preview

Request

  • Base URL: https://paperagent.dev
  • URL: https://paperagent.dev/v1/drafts/{id}/preview
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://paperagent.dev/oauth/authorize, token URL https://paperagent.dev/oauth/token, scopes: letters:read)
    • API key in header X-Api-Key
    • HTTP bearer

Path parameters

idstring required

Response

Success

draft_idstring required
preview_urlstring required

A time-limited link to the exact PDF that will be printed. Give it to the user; it dies with the draft.

page_countinteger required
tier'standard' | 'proof_of_mailing' | 'certified' | 'certified_err' | 'registered' required

The product this draft is priced as, as passed to create_draft.

tier_titlestring required

What the price card in force calls that product, such as Standard. Use this name when you tell the user what they are buying.

included_pagesinteger required

Printed pages the headline price covers. This draft is priced at that total up to this many pages.

expires_atstring required
requirementsstring[] required

What the user is agreeing to: how USPS requires the envelope to be printed, and what this particular letter is. State these to the user before calling send_letter.

Changes

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