For AI agents: visit https://developers.cleeng.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
CleengCleeng
API TutorialsAPI ReferenceAPI Changelog
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREECleeng
API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE
API TutorialsAPI ReferenceAPI Changelog

Overview

  • API Reference Overview
  • Best Practices
  • API Caching
  • Troubleshooting
    • How to Understand and Resolve Common API Errors (401, 429)

MediaStore API

  • Getting Started With MediaStore API
  • Identity Management
    • Registerpost
    • Loginpost
    • Refresh tokenpost
    • Revoke refresh tokensdel
    • Reset passwordput
    • Fetch publisher consentsget
    • Update customer's consentsput
    • Fetch customer localesget
    • Update passwordpatch
    • Fetch capture statusget
    • Update capture answersput
  • Checkout Implementation
    • Create orderpost
    • Get an orderget
    • Fetch payment method idsget
    • Update an orderpatch
    • List campaignsget
    • Get entitlementsget
    • Fetch offersget
    • Fetch offer detailsget
    • [V2] Fetch offer detailsget
    • Fetch offer details for specific customerget
    • Get a giftget
    • Update a giftpatch
    • Verify a giftget
    • Redeem a giftpost
    • Get Adyen payment methodspost
    • Payment with Adyenpost
    • Finalize payment with Adyenpost
    • Payment with PayPal Express Checkoutpost
    • Android Payment [Deprecated]post
    • Roku Paymentpost
    • Amazon FireTV Paymentpost
    • Purchase without payment detailspost
  • My Account
    • Fetch customer's dataget
    • Update customer's datapatch
    • Fetch customer's subscriptionsget
    • Update customer's subscriptionpatch
    • Fetch customer's passesget
    • Fetch customer's payment detailsget
    • Fetch customer's consentsget
    • Fetch customer's transactionsget
    • Fetch available switchesget
    • Switch subscriptionpost
    • List switchesget
    • Fetch switch detailsget
    • Update switchpatch
    • Apply couponpatch
    • Add Adyen payment detailspost
    • Finalize add Adyen payment detailspost
    • Add PayPal payment detailspost
    • Delete payment detailsdel
    • Fetch customer's offersget
    • Pause subscriptionpost
    • Resume subscription post
  • SSO Integration
    • SSO Loginpost

API 3.1

  • Getting Started With Core API
  • Configuration
    • Dunning actionsput
  • Payments
    • Create an orderpost
    • Get an orderget
    • Update an orderpatch
    • Create a paymentpost
    • Get payment by order IDget
    • Update a paymentpatch
    • Cancel a paymentpatch
    • List a customer authorised paymentsget
    • Create payment detailspost
    • Delete payment detailsdel
    • Fetch customer transactionsget
  • Customers
    • Register customerpost
    • Get customerget
    • List customersget
    • Update customerpatch
    • Request password resetpost
    • Delete customerdel
  • Offers
    • Create an offerpost
    • List offersget
    • Get an offerget
    • Update an offerpatch
    • Activate an offerpost
    • Deactivate an offerpost
    • Create offer localizationpost
    • Activate offer localizationpost
    • Deactivate offer localizationpost
    • Update offer localizationpatch
    • Create a season grouppost
    • Update a season grouppatch
    • List season groupsget
    • Get a season groupget
    • Delete a season groupdel
    • Create a season in a season grouppost
    • Update a season within a season grouppatch
    • Delete a season from a season groupdel
  • Subscriptions
    • Create subscriptionpost
    • Get a subscriptionget
    • List subscriptionsget
    • Update subscriptionpatch
    • Activate subscriptionpost
    • Cancel subscriptionpost
    • Terminate subscriptionpost
    • Fetch available switchesget
    • Switch subscriptionpost
    • List switchesget
    • Fetch switch detailsget
    • Update switchpatch
    • Fetch subscription switch settingsget
    • Transfer subscriptionpost
    • Revive subscriptionpost
    • Renew subscriptionpost
    • Pause subscription post
    • Resume subscriptionpost
  • Gift Subscriptions
    • Get a giftget
    • Update a giftpatch
    • Verify a giftget
    • Redeem a giftpost
  • Passes
    • Create a passpost
    • Get a passget
    • List passesget
    • Update a passpatch
    • Terminate a passpost
    • Transfer a passpost
  • Entitlements
    • List entitlementsget
    • Get entitlementsget
  • Campaigns & Coupons
    • List campaignsget

In-App Payments

  • Android [Deprecated]post
  • Rokupost
  • Amazon FireTVpost

IN-APP PAYMENTS_NEW

  • Getting Started With In-App API
  • Samsung TVpost
  • Check Samsung TV purchase statusget
  • Register Apple SK2 purchasepost
  • Transfer Apple SK2 purchasepost
  • Check Apple SK2 purchase synchronization statusget
  • Register Google Play purchasepost
  • Transfer Google Play purchasepost
  • Check Google Play purchase synchronization statusget
  • Viziopost
  • Check Vizio purchase statusget

Webhooks

  • Getting Started with Webhooks API
  • Endpoints
    • Create a webhook endpointpost
    • List webhook endpointsget
    • Get a webhook endpointget
    • Update a webhook endpoint patch
    • Delete a webhook endpointdel
    • Rotate endpoint signing secretpost
  • Event Types
    • List available event typesget
    • List endpoints subscribed to an event typeget

Authentication API

  • Getting Started With Authentication API
  • Hi5 Chatbot tokenget
  • Device Login Flow (PIN Pair)
    • Generate codepost
    • Authorize codepost
    • Check codeget
  • JSON Web Key Setget

Identity Service API

  • Auth0
    • Auth0 - Generate token [Early Access]post

Passes

API 3.1 provides the following endpoints for passes:

  • Create a pass
  • Get a pass
  • List passes
  • Update a pass
  • Terminate a pass
  • Transfer a pass

Updated about 1 year ago


Redeem a gift
Create a pass
Did this page help you?

Updated about 1 year ago


Redeem a gift
Create a pass
Did this page help you?