How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZeroSettle Cancel Flow API

Configurable cancel flow with retention offers

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

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

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

3 operations 3 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

ZeroSettle Cancel Flow 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 3

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

Cancel Flow 3

Configurable cancel flow with retention offers

GET
/iap/cancel-flow
Get Cancel Flow
getCancelFlow 1 param → 200401
POST
/iap/cancel-flow/respond
Submit Cancel Flow Response
submitCancelFlowResponse body → 200401
POST
/iap/cancel-flow/accept-offer
Accept Cancel Flow Offer
acceptCancelFlowOffer body → 200400401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CancelFlowOffer (5 properties), CancelFlow (5 properties), CancelFlowPause (5 properties), CancelFlowQuestion (4 properties). Each schema is shown below with its type and property counts.

CancelFlowPause
object
Pause option in the cancel flow.
5 properties
CancelFlow
object
Cancel flow configuration.
5 properties
Error
object
Error response.
2 properties 1 required
CancelFlowOffer
object
A retention offer in the cancel flow.
5 properties
CancelFlowQuestion
object
A survey question in the cancel flow.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zerosettle-cancel-flow-api-openapi.yml Raw ↑

Other APIs ZeroSettle publishes across the network.

ZeroSettle Checkout API
ZeroSettle Entitlements 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
Where this information came from

This is an independent, third-party profile of ZeroSettle Cancel Flow API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.