Check a fax
get_fax_statusUse this when the person asks how their fax is doing, or to see whether it's ready to pay. It reads the fax from its status_url and returns its status, page count, price, payment and attempts. checkout_available is true once the person can pay on the status page. It changes nothing. While a fax is sending, call it at most once a minute.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status_url | Yes | The status_url create_fax returned, like https://eu.faxette.com/f/abc123?token=xyz. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The fax's id. Pass it to get_fax when the person is signed in. | |
| price | Yes | Before tax. Null until the pages are counted. | |
| status | Yes | draft: waiting for files, or for a file to be fixed. processing_documents: counting pages. documents_ready: ready to pay. awaiting_payment: the person is paying. scheduled: paid, about to dial. sending, delivered, failed. canceled: not paid in time. | |
| attempt | Yes | The current attempt to dial the fax number. | |
| payment | Yes | The person's payment once they start paying, by card or from their credit. amount_cents includes tax. | |
| language | No | ||
| resend_by | Yes | For a failed fax: until when the person can correct the fax number on the status page and send it again. | |
| fax_number | Yes | ||
| page_count | Yes | Null until the pages are counted. | |
| review_url | No | A private review link, valid for 30 minutes. Give it to the person so they can inspect the prepared PDF before paying. | |
| status_url | Yes | The page where the person checks the fax and pays. Give it to them. | |
| max_attempts | Yes | ||
| checkout_quote | No | ||
| failure_reason | Yes | For a failed fax: temporary (busy or no answer on every attempt), wrong_number (no fax machine answered), or our_side. | |
| document_errors | Yes | Files Faxette couldn't use. position is the file's number in the fax. The person fixes them on the status page. | |
| next_attempt_at | Yes | When the next attempt dials, if the line was busy or didn't answer. | |
| checkout_available | Yes | True when the person can pay on the status page. |