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

ZeroSettle Products API

Fetch the product catalog for your app

ZeroSettle Products API is one of 12 APIs that ZeroSettle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against a single base URL, https://api.zerosettle.io/v1.

1 operations 1 paths 8 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.zerosettle.io/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ZeroSettle Products API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ZeroSettle-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your publishable API key. Use zspktest for sandbox or zspklive for production.

Paths & Operations 1

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

Products 1

Fetch the product catalog for your app

GET
/iap/products
Get Products
getProducts 2 params → 200401403

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Offer (15 properties), Product (10 properties), MigrationCampaign (9 properties), OfferDisplay (8 properties). Each schema is shown below with its type and property counts.

CheckoutConfig
object
Configuration for how the SDK should present checkout.
4 properties
Product
object
A product in the catalog.
10 properties
MigrationCampaign
object
An active Switch & Save migration campaign.
9 properties
Price
object
A price in micros (1/1,000,000 of the currency unit).
2 properties
OfferDisplay
object
Server-configurable copy for every tip card state. Empty strings mean the SDK should use its hardcoded defaults.
8 properties 8 required
JurisdictionConfig
object
Checkout configuration for a specific jurisdiction.
2 properties
Error
object
Error response.
2 properties 1 required
Offer
object
Unified offer payload for migration and upgrade flows.
15 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zerosettle-products-api-openapi.yml Raw ↑

Other APIs ZeroSettle publishes across the network.

ZeroSettle Cancel Flow API
ZeroSettle Checkout API
ZeroSettle Entitlements API
ZeroSettle Events API
ZeroSettle Migration API
ZeroSettle Restore API
ZeroSettle StoreKit API
ZeroSettle Subscriptions API
ZeroSettle Transactions API
ZeroSettle Upgrade Offers API
ZeroSettle User Offer API