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

Zype Monetization API

Subscriptions with a reversible cancel/reactivate pair, plans and tiered plan-to-playlist binding, transactions carrying Stripe/Braintree/Recurly references, redemption codes with bulk minting and redemption, IAB VAST/VMAP ad tags, revenue models and video favorites. 36 operations.

Zype Monetization API is one of 15 APIs that Zype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monetization, Subscription, Advertising, VAST, and Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 36 operations across 20 paths, organized into 7 resource areas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.zype.com/.

36 operations 20 paths 0 schemas 6 DELETE13 GET8 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.zype.com/
Authentication
API Key, HTTP Bearer
Resource Areas
7

Authentication & Security 2

Zype Monetization API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). It accepts HTTP bearer tokens (OAuth access token) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth access token of the consumer

Paths & Operations 36

Across 20 paths, the API surfaces 36 operations — 6 DELETE, 13 GET, 8 POST, 9 PUT. They span 7 resource areas: Subscriptions, Plans, Transactions, Redemption Codes, Ad Tags, Revenue Models, Video Favorites. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 7
GET
/subscriptions
List Subscriptions
listSubscriptions 15 params → 200
POST
/subscriptions
Create a Subscription
createSubscription body → 201422
GET
/subscriptions/{id}
View Subscription
getSubscription 1 param → 200404
PUT
/subscriptions/{id}
Update Subscription
updateSubscription 1 param body → 200404422
DELETE
/subscriptions/{id}
Delete Subscription
deleteSubscription 1 param → 204404
PUT
/subscriptions/{id}/cancel
Cancel Subscription
cancelSubscription 1 param → 200404422
PUT
/subscriptions/{id}/reactivate
Reactivate Cancelled Subscription
reactivateSubscription 1 param → 200404422
Plans 7
GET
/plans
List Plans
listPlans 7 params → 200
POST
/plans
Create Plan
createPlan body → 201422
GET
/plans/{id}
View Plan
getPlan 1 param → 200404
PUT
/plans/{id}
Update Plan
updatePlan 1 param body → 200404422
DELETE
/plans/{id}
Delete Plan
deletePlan 1 param → 204404422
PUT
/plans/{id}/add_playlists
Add Playlists to a Tiered Subscription Plan
addPlaylists 1 param body → 200404422
PUT
/plans/{id}/remove_playlists
Remove Playlists from a Subscription Plan
removePlaylists 1 param body → 200404422
Transactions 5
GET
/transactions
List Transactions
listTransactions 8 params → 200422
POST
/transactions
Create Transactions
createTransaction body → 201422
GET
/transactions/{id}
View Transaction
getTransaction 1 param → 200404
PUT
/transactions/{id}
Update a Transaction
updateTransaction 1 param body → 200404422
DELETE
/transactions/{id}
Delete Transaction
deleteTransaction 1 param → 204404
Redemption Codes 7
GET
/redemption_codes
List Redemption Codes
listRedemptionCodes 16 params → 200422
POST
/redemption_codes
Create Redemption Codes
createRedemptionCode body → 201422
GET
/redemption_codes/{id_or_code}
View Redemption Code
getRedemptionCode 1 param → 200404
PUT
/redemption_codes/{id_or_code}
Update Redemption Code
updateRedemptionCode 1 param body → 200404422
DELETE
/redemption_codes/{id_or_code}
Delete Redemption Code
deleteRedemptionCode 1 param → 204404
POST
/redemption_codes/redeem
Redeem an available Redemption Code
redeem body → 200404422
POST
/redemption_codes/bulk_create
Create multiple Redemption Codes at once
bulkCreate body → 200422
Ad Tags 5
GET
/ad_tags
List Ad Tags
listAdTags 11 params → 200422
POST
/ad_tags
Create Ad Tags
createAdTag body → 201422
GET
/ad_tags/{id}
View Ad Tag
getAdTag 1 param → 200404
PUT
/ad_tags/{id}
Update Ad Tag
updateAdTag 1 param body → 200404422
DELETE
/ad_tags/{id}
Delete Ad Tag
deleteAdTag 1 param → 204404
Revenue Models 2
GET
/revenue_models
List Revenue Models
listRevenueModels 8 params → 200422
GET
/revenue_models/{id}
View Revenue Model
getRevenueModel 1 param → 200404
Video Favorites 3
GET
/consumers/{consumer_id}/video_favorites
List Video Favorites
listVideoFavorites 4 params → 200
POST
/consumers/{consumer_id}/video_favorites
Create Video Favorite
createVideoFavorite 2 params → 201422
DELETE
/consumers/{consumer_id}/video_favorites/{favorite_id}
Delete Video Favorite
deleteVideoFavorite 2 params → 204404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zype-monetization.json Raw ↑

Other APIs Zype publishes across the network.

Zype Platform API
Zype Playout Scheduler API
Zype Consumers API
Zype Live API (V3)
Zype Zobjects API
Zype Analytics API (V3)
Zype Analytics API (V2)
Zype Custom Regions API
Zype Content Rule Groups API
Zype Content Rule Profiles API
Zype TVE API
Zype Consumer Authentication API
Where this information came from

This is an independent, third-party profile of Zype Monetization 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.