Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zest Subscriptions API

Create one or more subscriptions for a single SPV.

Zest Subscriptions API is one of 8 APIs that Zest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://sandbox-api.zestequity.com.

1 operations 1 paths 8 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://public-api.zestequity.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zest Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 1

Create one or more subscriptions for a single SPV.

POST
/v1/spvs/{spv_slug}/subscriptions
Create subscriptions for one SPV
createSubscriptions 2 params body → 201400401403404409422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SubscriptionResult (7 properties), SubscriptionCreateRow (4 properties), PartnerErrorResponse (4 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

PartnerValidationError
object
3 properties 3 required
ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
SubscriptionResult
object
7 properties 6 required
PartnerErrorResponse
object
4 properties 1 required
SubscriptionBulkResponse
object
1 property 1 required
SubscriptionCreateRow
object
4 properties 3 required
SubscriptionBulkCreate
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zest-subscriptions-api-openapi.yml Raw ↑

Other APIs Zest publishes across the network.

Zest Authentication API
Zest Contracts API
Zest Investors API
Zest SPV Requests API
Zest Subscription Forms API
Zest Subscription Fundings API
Zest System API