GeezerVison

docs/Model/ErrorOrMultipleErrorsResponse.md

docs/Model/ErrorResponse.md

docs/Model/Folder.md

docs/Model/ForbiddenErrorResponse.md

docs/Model/JsonSchema.md

docs/Model/ListSubmissionsResponse.md

docs/Model/MoveFolderData.md

lib/Model/ErrorOrMultipleErrorsResponse.php

lib/Model/ErrorResponse.php

lib/Model/Folder.php

lib/Model/ForbiddenErrorResponse.php

lib/Model/JsonSchema.php

lib/Model/ListSubmissionsResponse.php

lib/Model/ModelInterface.php

test/Model/ErrorOrMultipleErrorsResponseTest.php

test/Model/ErrorResponseTest.php

test/Model/FolderTest.php

test/Model/ForbiddenErrorResponseTest.php

test/Model/JsonSchemaTest.php

test/Model/ListSubmissionsResponseTest.php

test/Model/MoveFolderDataTest.php

- Submissions and combined submissions can be in the new `insufficient_credits` state: a live PDF that your credit

balance can't cover is saved and processed once you add credits. See

https://docspring.com/docs/api-guide/credits-and-rate-limits/.

- generate_pdf, batch_generate_pdfs and combine_pdfs document the 402 response for insufficient credits. Their

responses can include a `code`, which is `insufficient_credits` on a 402.

- generate_pdf, batch_generate_pdfs, create_pdf_template, create_pdf_template_from_upload, create_html_template and

copy_template document a 403 response with a `code` of `upgrade_required` (the plan doesn't include it) or

`account_suspended`.

- Templates: new `parse_dates_using_template_date_format` setting, when you create or update a template. When it's

[Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·

[Packagist](https://packagist.org/packages/docspring/docspring) · [Changelog](https://github.com/DocSpring/docspring-php/blob/main/CHANGELOG.md)

Version 3.2.0. Requires PHP ^8.1.

Version 3.3.0. Requires PHP ^8.1.

{

"name": "docspring/docspring",

"version": "3.2.0",

"description": "Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.",

"version": "3.3.0",

"description": "Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).",

"keywords": [

"openapitools",

"openapi-generator",

Generate multiple PDFs

Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits

Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. Live PDFs use credits. If any live submission is waiting for credits, the API returns 402 and the others are still processed: check each submission's `state`. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits

Merge submission PDFs, template PDFs, or custom files

Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.

Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided. Combining uses credits (4 per source PDF, plus 4 per unit of the combined PDF), even with a test API token or watermarked source PDFs. If your balance can't cover it, the API returns 402 and the combined submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).

Generate a PDF

Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately. See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields

Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately. Live PDFs use credits; test PDFs (`test: true`) are free and watermarked. If your balance can't cover a live PDF, the API returns 402 and the submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields

Check the status of a combined submission (merged PDFs)

Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).

Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads). `insufficient_credits` means the combined submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`.

Check the status of a PDF

Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.

Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing. `insufficient_credits` means the submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`.

Check the status of a submission batch job

Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.

Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing. Submissions waiting for credits are in the `insufficient_credits` state and count as pending, so the batch stays `pending` until you add credits or they stop waiting after 30 days.

**errors** | **string[]** | | [optional]

**submission_batch** | [**\DocSpring\Model\SubmissionBatch**](SubmissionBatch.md) | |

**submissions** | **object[]** | |

**code** | **string** | `insufficient_credits` when the response is a 402. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

**metadata** | **object** | | [optional]

**password** | **string** | | [optional]

**source_pdfs** | **object[]** | |

**test** | **bool** | Deprecated, and has no effect. A combined PDF is a test or live document because of its source PDFs. | [optional]

**test** | **bool** | Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

------------ | ------------- | ------------- | -------------

**status** | **string** | |

**combined_submission** | [**\DocSpring\Model\CombinedSubmission**](CombinedSubmission.md) | |

**error** | **string** | | [optional]

**errors** | **string[]** | | [optional]

**code** | **string** | `insufficient_credits` when the response is a 402. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

------------ | ------------- | ------------- | -------------

**status** | **string** | |

**custom_file** | [**\DocSpring\Model\CustomFile**](CustomFile.md) | |

**error** | **string** | | [optional]

**errors** | **string[]** | | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)