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 Entitlements API

Query user entitlements (active purchases and subscriptions)

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

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

This API exposes 2 operations across 2 paths, and defines 2 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.

2 operations 2 paths 2 schemas 1 GET1 POST

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 Entitlements 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 2

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

Entitlements 2

Query user entitlements (active purchases and subscriptions)

GET
/iap/entitlements
Get Entitlements
getEntitlements 2 params → 200400401
POST
/iap/claim-entitlement/
Claim Entitlement
claimEntitlement body → 200400401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Entitlement (12 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
Error response.
2 properties 1 required
Entitlement
object
A user's entitlement to a product.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zerosettle-entitlements-api-openapi.yml Raw ↑

Other APIs ZeroSettle publishes across the network.

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