Jump to Content
Cleeng
API TutorialsAPI ReferenceAPI Changelog
HELP CENTERINTEGRATIONSSTATUS PAGESIGN UPCleeng
API Reference
HELP CENTERINTEGRATIONSSTATUS PAGESIGN UP
API TutorialsAPI ReferenceAPI Changelog

Overview

  • API Reference Overview
  • Best Practices
  • API Caching

MediaStore API

  • Getting started
  • Identity Management
    • Registerpost
    • Loginpost
    • Refresh tokenpost
    • Revoke refresh tokensdelete
    • 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 Paymentpost
    • 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 detailsdelete
    • Fetch customer's offersget
  • 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 detailsdelete
    • Fetch customer transactionsget
  • Customers
    • Register customerpost
    • Get customerget
    • List customersget
    • Update customerpatch
    • Request password resetpost
    • Delete customerdelete
  • Offers
    • Create an offerpost
    • List offersget
    • Get an offerget
  • 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 subscription [Beta]post
    • Revive subscription [Beta]post
    • Renew subscription [Beta]post
  • Gift Subscriptions
    • Get a giftget
    • Update a giftpatch
    • Verify a giftget
    • Redeem a giftpost
  • Passes [Beta]
    • Create a pass [Beta]post
    • Get a pass [Beta]get
    • List passes [Beta]get
    • Update a pass [Beta]patch
    • Terminate a pass [Beta]post
  • Entitlements
    • List entitlementsget
    • Get entitlementsget
  • Campaigns & Coupons
    • List campaignsget

In-App Payments

  • Androidpost
  • Apple iOS and tvOSpost
  • Rokupost
  • Amazon FireTVpost

IN-APP PAYMENTS_NEW

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

Authentication API

  • Getting Started With Authentication API
  • Hi5 Chatbot tokenget
  • Device Login Flow (PIN Pair) [Beta]
    • Generate code [Beta]post
    • Authorize code [Beta]post
    • Check code [Beta]get

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 [Beta]

API 3.1 provides the following endpoints for passes:

  • POST /3.1/passes
  • GET /3.1/passes/{passId}
  • GET /3.1/passes
  • PATCH /3.1/passes/{passId}
  • POST /3.1/passes/{passId}/terminate