ZeroSettle · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for ZeroSettle IAP API

4 actions 4 updates update extends ../openapi/zerosettle-openapi.json

Generated by API Evangelist Written by API Evangelist tooling for ZeroSettle's API. It is a proposal applied on top of the contract, not a document ZeroSettle publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-api-evangelistx-environmentsx-conventionsx-environment-select-by-prefix

Targets 2

$.info

$.components.securitySchemes.ApiKeyAuth

OpenAPI Overlay

x-generated: '2026-07-21'
x-method: generated
x-source: openapi/zerosettle-openapi.json
overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for ZeroSettle IAP API
  version: 1.0.0
extends: ../openapi/zerosettle-openapi.json
actions:
- target: $.info
  description: Annotate the API with API Evangelist network metadata and provider identity.
  update:
    x-api-evangelist:
      provider: zerosettle
      network: https://apis.io/
      categories:
      - payments
      - in-app-purchase
      - subscriptions
      - merchant-of-record
      docs: https://docs.zerosettle.io/api-reference/introduction
      llms_txt: https://docs.zerosettle.io/llms.txt
- target: $.info
  description: Record the environment model conveyed by the publishable-key prefix.
  update:
    x-environments:
      sandbox:
        key_prefix: zs_pk_test_
        processor: Stripe test
      live:
        key_prefix: zs_pk_live_
        processor: Stripe live
- target: $.info
  description: Record error-envelope and pagination conventions for consumers.
  update:
    x-conventions:
      error_envelope: '{ error: string, code?: string }'
      problem_json: false
      pagination: limit-only
      idempotency: server-side (Merchant of Record); no consumer Idempotency-Key header
- target: $.components.securitySchemes.ApiKeyAuth
  description: Clarify that the key prefix selects the environment.
  update:
    x-environment-select-by-prefix: true