| id |
UUID |
The unique identifier of the package. |
[default to null] |
| name |
String |
The display name of the package. |
[default to null] |
| status |
String |
The current lifecycle status. One of: Draft, Scheduled, Queued, Sent, Viewed, InProgress, Completed, Declined, Voided, Expired. |
[default to null] |
| createdOn |
Date |
When the package was created (UTC). |
[default to null] |
| sentOn |
Date |
When the package was sent for signing (UTC). Null if not yet sent. |
[default to null] |
| completedOn |
Date |
When all signers completed signing (UTC). Null if not yet completed. |
[default to null] |
| enforceSigningOrder |
Boolean |
Whether signers are required to sign in sequential routing order. |
[default to null] |
| expirationDate |
Date |
The package expiration date (UTC). After this date, the package transitions to Expired status. Null if no expiration is set. |
[default to null] |
| scheduledSendOn |
Date |
When the package is scheduled to be sent (UTC). Null if not scheduled. Only present when status is Scheduled. |
[default to null] |
| requiresPayment |
Boolean |
Whether at least one signer must make a payment before signing. |
[default to null] |
| paymentAmount |
Double |
The default payment amount for the package. |
[default to null] |
| paymentStatus |
String |
The aggregate payment status across all paying signers. One of: Pending, Completed, Failed. Null if payment is not required. |
[default to null] |
| documentCount |
Integer |
The total number of documents in the package. |
[default to null] |
| signerCount |
Integer |
The total number of signers (all types) in the package. |
[default to null] |
| completedSignerCount |
Integer |
The number of signers who have completed signing. |
[default to null] |
| emailSubject |
String |
The custom email subject for signing notifications. |
[optional] [default to null] |
| emailMessage |
String |
The custom email body text for signing notifications. |
[optional] [default to null] |
| paymentCurrency |
String |
The ISO 4217 currency code for payments. |
[optional] [default to null] |
| paymentDescription |
String |
The payment description shown to signers. |
[optional] [default to null] |
| voidedOn |
Date |
When the package was voided (UTC). Null if not voided. |
[optional] [default to null] |
| voidedReason |
String |
The reason provided when the package was voided. Null if not voided. |
[optional] [default to null] |
| isArchived |
Boolean |
Whether the package is currently archived (hidden from the default list). |
[optional] [default to false] |
| archivedOn |
Date |
When the package was archived (UTC). Null if not archived. |
[optional] [default to null] |
| reminderEnabled |
Boolean |
Whether automatic reminder emails are enabled for this package. |
[optional] [default to false] |
| reminderIntervalDays |
Integer |
The number of days between automatic reminder emails. Null if reminders are disabled. |
[optional] [default to null] |
| expirationDateDisplay |
String |
The expiration date formatted for display in the tenant's timezone (e.g., "Apr 15, 2026 at 5:00 PM CDT"). |
[optional] [default to null] |
| timeZoneId |
String |
The IANA timezone ID used for date display (e.g., "America/Chicago"). |
[optional] [default to null] |
| createdByEmail |
String |
The email address of the user who created the package. |
[optional] [default to null] |
| createdByName |
String |
The display name of the user who created the package. |
[optional] [default to null] |
| creationSource |
String |
How the package was created. `null` for portal UI clicks, "Api" for direct external API callers (Zapier / Make.com / MCP / raw REST), "HubSpot Workflow" for HubSpot Workflow Custom Actions, "BulkSend" for Bulk Send From Template runs, etc. Any non-null value bills into the API package sub-limit; `null` bills into the Web bucket. |
[optional] [default to null] |
| currentStep |
CurrentStepApiResponse |
The current signing step details when the package is in progress. Null for packages in other statuses. |
[optional] [default to null] |
| externalReferenceId |
String |
|
[optional] [default to null] |
| metadata |
String |
|
[optional] [default to null] |
| modifiedOn |
Date |
|
[optional] [default to null] |
| enableInstantBankTransfer |
Boolean |
|
[optional] [default to false] |
