Skip to main content
POST
Estimate Fax Cost

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Inputs for a pre-send cost estimate.

Takes gcs_paths directly (mirroring SendFaxRequest) because the compose dialog hasn't persisted FaxAttachment rows yet at estimate time.

gcsPaths
string[]
required
Minimum array length: 1
Required string length: 1 - 500
coverSheet
CoverSheetInput · object | null

Composer-supplied cover-sheet content prepended to the merged fax.

The 800-char message cap guarantees the cover always fits on one page, which in turn keeps the rendered "Pages to follow" line correct without a second pass.

Response

Successful Response

Pre-send cost estimate using the tenant's PER_FAX_MINUTE rate.

numPages
integer
required
estimatedMinutes
number
required
ratePerMinuteCents
integer
required
estimatedCostCents
integer
required