Jump to Content
Cleeng
API TutorialsAPI ReferenceAPI Changelog
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREECleeng
API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE
API TutorialsAPI ReferenceAPI Changelog
All
Pages
Start typing to search…

Overview

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

MediaStore API

  • Getting started
  • 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 Paymentpost
    • Apple iOS and tvOS 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 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
    • Webhook settingsput
    • List webhook subscriptionsget
    • 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

  • Androidpost
  • Apple iOS and tvOS [Deprecated]post
  • Rokupost
  • Amazon FireTVpost

IN-APP PAYMENTS_NEW

  • Getting Started With In-App API [Early Access]
  • Samsung TVpost
  • Check Samsung TV purchase statusget
  • Register Apple SK2 purchasepost
  • Transfer Apple SK2 purchasepost
  • Check Apple SK2 purchase synchronization statusget
  • Vizio [Early Access]post
  • Check Vizio purchase status [Early Access]get

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

JSON-RPC [DEPRECATED]

  • Getting Started With JSON-RPC

Identity Management (JSON-RPC)

  • registerCustomer
  • Consent Management
    • getConsentDefinitions
    • getViewerConsents
    • submitConsent
  • Customer Token
    • generateCustomerToken
    • extendTokenExpiration
    • generateCustomerTokenFromPassword
    • generateCustomerTokenFromExternalId
  • Cleeng Capture
    • fetchCaptureQuestions
    • fetchCaptureStatus
    • fetchBroadcasterSpecificPersonalDataWithCaptureAnswers
    • updateBroadcasterSpecificPersonalDataWithCaptureAnswers
  • Account Management
    • getCustomerEmail
    • getCustomer
    • requestPasswordReset
    • updateCustomerEmail
    • updateCustomerPassword
    • updateCustomerSubscription
    • listCustomerLibrary
    • listCustomerSubscriptions
  • SSO integration
    • getLocaleDataFromIp
    • generateMyAccountUrl

Payment and Billing (JSON RPC)

  • listPaymentDetails
  • deletePaymentDetails

In-App (JSON RPC)

  • generateCustomerTokenFromTransactionId

Offer Management (JSON-RPC)

  • General Offer Management
    • getOfferDetails
  • Single Offers
    • listSingleOffers
  • Rental Offers
    • listRentalOffers
  • Subscriptions
    • getSubscriptionOffer
    • listSubscriptionOffers
  • Pass Offers
    • listPassOffers

Entitlement (JSON-RPC)

  • Entitlements
    • getAccessStatus
    • getAccessStatusForDevice
    • getAccessibleTags
    • registerSubscription
    • isTrialAllowed

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