> ## 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.

# Create subscriptions for one SPV

> Creates one or more subscription rows for a single SPV. Per investor: lump sum + share class. `Idempotency-Key` is optional.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/spvs/{spv_slug}/subscriptions
openapi: 3.1.0
info:
  title: Zest equity public api API
  version: 0.1.0
servers:
  - url: https://sandbox-api.zestequity.com
    description: Staging
security: []
tags:
  - name: Authentication
    description: >-
      OAuth 2.0 JWT-Bearer assertion grant. Exchange a partner-signed JWT for a
      short-lived bearer access token, then send that token in the Authorization
      header on every partner API call.
  - name: SPV Requests
    description: >-
      Submit SPV creation requests, inspect their lifecycle, and cancel pending
      ones. SPV requests are reviewed by Zest admins and produce SPV
      materialisation on approval.
  - name: Investors
    description: >-
      Bulk-create investor records with partial-success semantics. Each row
      carries its own status / error envelope so a single bad row never fails
      the batch.
  - name: Subscriptions
    description: Create one or more subscriptions for a single SPV.
  - name: Subscription Forms
    description: >-
      Upload signed subscription forms (PDF or image) for partner-managed
      subscriptions. Files are streamed to private storage and referenced on the
      Bid.
  - name: Subscription Fundings
    description: >-
      Upload wire-transfer receipts plus funding metadata. Strict order: a
      signed form must already be on record before fundings can be uploaded.
  - name: Contracts
    description: >-
      Read-only access to the spaas-contract registry (templates, catalogs,
      primitives, samples) used to validate SPV-request `attributes`.
  - name: System
    description: Service health and OpenAPI introspection endpoints.
paths:
  /v1/spvs/{spv_slug}/subscriptions:
    post:
      tags:
        - Subscriptions
      summary: Create subscriptions for one SPV
      description: >-
        Creates one or more subscription rows for a single SPV. Per investor:
        lump sum + share class. `Idempotency-Key` is optional.
      operationId: createSubscriptions
      parameters:
        - required: true
          schema:
            type: string
            title: Spv Slug
          name: spv_slug
          in: path
        - required: false
          schema:
            type: string
            title: Idempotency-Key
          name: Idempotency-Key
          in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionBulkCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionBulkResponse'
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerErrorResponse'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerErrorResponse'
        '403':
          description: Service not provisioned for partner API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerErrorResponse'
        '404':
          description: SPV not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerErrorResponse'
        '409':
          description: Idempotency-Key conflict (different body)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SubscriptionBulkCreate:
      properties:
        subscriptions:
          items:
            $ref: '#/components/schemas/SubscriptionCreateRow'
          type: array
          title: Subscriptions
      type: object
      required:
        - subscriptions
      title: SubscriptionBulkCreate
    SubscriptionBulkResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/SubscriptionResult'
          type: array
          title: Results
      type: object
      required:
        - results
      title: SubscriptionBulkResponse
    PartnerErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          default: 'ex: Something went wrong'
          examples:
            - Something went wrong
        errorId:
          type: string
          title: Errorid
        code:
          type: string
          title: Code
          description: Stable top-level error code (see PartnerErrorCode enum).
        validationErrors:
          items:
            $ref: '#/components/schemas/PartnerValidationError'
          type: array
          title: Validationerrors
          description: Populated only when code='validation_error'.
      type: object
      required:
        - code
      title: PartnerErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SubscriptionCreateRow:
      properties:
        partnerSubscriptionId:
          type: string
          title: Partnersubscriptionid
          description: >-
            Optional partner-side subscription id; echoed on the response for
            correlation.
          example: acme-sub-9921
        zestPersonId:
          type: string
          title: Zestpersonid
          example: psn_abc123
        lumpSum:
          type: object
          title: Lumpsum
          description: >-
            {currency, value} object — currency is ISO 4217, value is a decimal
            string.
          example:
            currency: USD
            value: '50000.00'
        shareClassSlug:
          type: string
          title: Shareclassslug
          example: sc_classA
      type: object
      required:
        - zestPersonId
        - lumpSum
        - shareClassSlug
      title: SubscriptionCreateRow
    SubscriptionResult:
      properties:
        partnerSubscriptionId:
          type: string
          title: Partnersubscriptionid
        subscriptionSlug:
          type: string
          title: Subscriptionslug
        spvSlug:
          type: string
          title: Spvslug
        personId:
          type: string
          title: Personid
        status:
          type: string
          title: Status
        lumpSum:
          type: object
          title: Lumpsum
        shareClassSlug:
          type: string
          title: Shareclassslug
      type: object
      required:
        - subscriptionSlug
        - spvSlug
        - personId
        - status
        - lumpSum
        - shareClassSlug
      title: SubscriptionResult
    PartnerValidationError:
      properties:
        attribute:
          type: string
          title: Attribute
          description: Attribute path (e.g. 'deal_name', 'share_class.name').
        code:
          type: string
          title: Code
          description: Stable validation error code (see ValidationErrorCode enum).
        message:
          type: string
          title: Message
          description: Human-readable message.
      type: object
      required:
        - attribute
        - code
        - message
      title: PartnerValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````