Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zestequity.com/llms.txt

Use this file to discover all available pages before exploring further.

When fired

Emitted when a Zest admin transitions the underlying Bid (with source=partner-api) to its terminal Completed status. This happens after the funding receipt has been validated against the wire transfer.

Envelope fields

eventId
string
required
Unique per delivery.
eventType
string
required
Always "subscription.completed".
occurredAt
string (ISO 8601 UTC)
required
Timestamp the admin completed the bid.
data
object
required
See payload schema below.

data schema

subscriptionSlug
string
required
Stable subscription identifier.
spvSlug
string
required
SPV slug.
personId
string
required
Zest person id of the investor.
partnerInvestorId
string
Echoed when the originating subscription carried one.
partnerSubscriptionId
string
Echoed when the originating subscription carried one.
completedAt
string (ISO 8601 UTC)
required
Timestamp the admin marked the bid as completed.
status
string
required
Always "completed" for this event.

Example

{
  "eventId": "wde_82a00b41c4f63aa1",
  "eventType": "subscription.completed",
  "occurredAt": "2026-05-09T10:00:00.000Z",
  "data": {
    "subscriptionSlug": "sub_p9q8r7",
    "spvSlug": "veh_klm456",
    "personId": "psn_abc123",
    "partnerInvestorId": "acme-inv-7341",
    "partnerSubscriptionId": "acme-sub-9921",
    "completedAt": "2026-05-09T10:00:00.000Z",
    "status": "completed"
  }
}