How can we help?

Monetization APIs Overview Follow

Zype's Monetization APIs support a wide range of monetization types. These include subscriptions and pass plans, purchases, rentals, redemption codes, and ad monetization. Using the Monetization APIs you can build and manage transaction paywalls on videos or generate revenue with ads. Below you'll find a list of our Monetization API endpoints, along with a brief description of what they do and a link to the developer documentation.

  • Subscription Plan API - used to create, update, delete, and retrieve subscription plans. You should use this API whenever you'd like to create new subscription plans, need to update a subscription for a consumer, or delete a subscription plan.
  • Transactions API - used to create, update, delete, retrieve, and list transactions (purchases or rentals) that within your property. Use this API to create transactions, update information in any transaction, find and list any transaction, and delete transactions (such as testing transactions). This is used for pass plans and rentals. 
  • Pass Plans API - used to retrieve and list pass plans. This API is good for those customers that are looking for a specific pass plan or want to list out all plans.  
  • Redemption Codes API - used to create (single or bulk), update, delete, list, and retrieve redemption codes. This API can also allow consumers to redeem a redemption code. Use this on videos or playlists you'd like consumers to have promotional access to.
  • Video Entitlements API - used to check if consumers have entitlement (access) to transaction paywalled videos, as well as to create, update, delete, and retrieve video entitlements from your Zype property. Video entitlements allow you to provide access to transaction paywalled videos to individual consumers. Use this API if you'd like to see if an individual consumer already has entitlement access to a video, or if you'd like to provide entitlement access to a consumer to a paywalled video following successful purchase of that video.
  • Playlist Entitlements API - used to check if consumers have entitlement (access) to transaction paywalled playlist of videos, as well as to create, update, delete, and retrieve playlist entitlements from your Zype property. Playlist entitlements allow you to provide access to transaction paywalled collection of videos (a playlist) to individual consumers. Use this API if you'd like to see if an individual consumer already has entitlement access to a playlist, or if you'd like to provide entitlement access to a consumer to a paywalled playlist following successful purchase of that playlist.
  • Ad Tag API - This API is used to create, update, delete, retrieve, and list ad tags associated with your account. Create and manage ad tags, update tag information, delete an unwanted ad tag, list all tags associated with your account. 
  • Revenue Models API - use this to list and retrieve the revenue models associated with your account. This API is great if you're looking for analytics based on revenue type. 

Comments

Please sign in to leave a comment.