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 once per subscription successfully created by POST /v1/spvs/{spv_slug}/subscriptions. The subscription is in pending status and is ready to receive a signed form upload. Under the hood, each subscription auto-creates a Bid with source=partner-api.

Envelope fields

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

data schema

subscriptionSlug
string
required
Stable subscription identifier.
spvSlug
string
required
The SPV the subscription belongs to.
personId
string
required
Zest person id of the investor.
partnerSubscriptionId
string
Echoed from the request when supplied.
lumpSum
object
required
Investment amount as { "currency": "USD", "value": "50000.00" }.
shareClassSlug
string
required
Slug of the share class on this subscription.
status
string
required
Always "pending" for this event.

Example

{
  "eventId": "wde_91ee5c2a7f6304bd",
  "eventType": "subscription.created",
  "occurredAt": "2026-05-07T14:32:18.000Z",
  "data": {
    "subscriptionSlug": "sub_p9q8r7",
    "spvSlug": "veh_klm456",
    "personId": "psn_abc123",
    "partnerSubscriptionId": "acme-sub-9921",
    "lumpSum": { "currency": "USD", "value": "50000.00" },
    "shareClassSlug": "sc_classA",
    "status": "pending"
  }
}