Jump to Content
API Tutorials
API Reference
API Changelog
HELP CENTER
INTEGRATIONS
STATUS PAGE
LOGIN
GET STARTED FREE
API Reference
HELP CENTER
INTEGRATIONS
STATUS PAGE
LOGIN
GET STARTED FREE
API Tutorials
API Reference
API Changelog
getAccessStatus
All
Pages
Start typing to search…
JUMP TO
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
Register
post
Login
post
Refresh token
post
Revoke refresh tokens
del
Reset password
put
Fetch publisher consents
get
Update customer's consents
put
Fetch customer locales
get
Update password
patch
Fetch capture status
get
Update capture answers
put
Checkout Implementation
Create order
post
Get an order
get
Fetch payment method ids
get
Update an order
patch
List campaigns
get
Get entitlements
get
Fetch offers
get
Fetch offer details
get
[V2] Fetch offer details
get
Fetch offer details for specific customer
get
Get a gift
get
Update a gift
patch
Verify a gift
get
Redeem a gift
post
Get Adyen payment methods
post
Payment with Adyen
post
Finalize payment with Adyen
post
Payment with PayPal Express Checkout
post
Android Payment
post
Apple iOS and tvOS Payment [Deprecated]
post
Roku Payment
post
Amazon FireTV Payment
post
Purchase without payment details
post
My Account
Fetch customer's data
get
Update customer's data
patch
Fetch customer's subscriptions
get
Update customer's subscription
patch
Fetch customer's passes
get
Fetch customer's payment details
get
Fetch customer's consents
get
Fetch customer's transactions
get
Fetch available switches
get
Switch subscription
post
List switches
get
Fetch switch details
get
Update switch
patch
Apply coupon
patch
Add Adyen payment details
post
Finalize add Adyen payment details
post
Add PayPal payment details
post
Delete payment details
del
Fetch customer's offers
get
Pause subscription
post
Resume subscription
post
SSO Integration
SSO Login
post
API 3.1
Getting Started With Core API
Configuration
Webhook settings
put
List webhook subscriptions
get
Dunning actions
put
Payments
Create an order
post
Get an order
get
Update an order
patch
Create a payment
post
Get payment by order ID
get
Update a payment
patch
Cancel a payment
patch
List a customer authorised payments
get
Create payment details
post
Delete payment details
del
Fetch customer transactions
get
Customers
Register customer
post
Get customer
get
List customers
get
Update customer
patch
Request password reset
post
Delete customer
del
Offers
Create an offer
post
List offers
get
Get an offer
get
Update an offer
patch
Activate an offer
post
Deactivate an offer
post
Create offer localization
post
Activate offer localization
post
Deactivate offer localization
post
Update offer localization
patch
Create a season group
post
Update a season group
patch
List season groups
get
Get a season group
get
Delete a season group
del
Create a season in a season group
post
Update a season within a season group
patch
Delete a season from a season group
del
Subscriptions
Create subscription
post
Get a subscription
get
List subscriptions
get
Update subscription
patch
Activate subscription
post
Cancel subscription
post
Terminate subscription
post
Fetch available switches
get
Switch subscription
post
List switches
get
Fetch switch details
get
Update switch
patch
Fetch subscription switch settings
get
Transfer subscription
post
Revive subscription
post
Renew subscription
post
Pause subscription
post
Resume subscription
post
Gift Subscriptions
Get a gift
get
Update a gift
patch
Verify a gift
get
Redeem a gift
post
Passes
Create a pass
post
Get a pass
get
List passes
get
Update a pass
patch
Terminate a pass
post
Transfer a pass
post
Entitlements
List entitlements
get
Get entitlements
get
Campaigns & Coupons
List campaigns
get
In-App Payments
Android
post
Apple iOS and tvOS [Deprecated]
post
Roku
post
Amazon FireTV
post
IN-APP PAYMENTS_NEW
Getting Started With In-App API [Early Access]
Samsung TV
post
Check Samsung TV purchase status
get
Register Apple SK2 purchase
post
Transfer Apple SK2 purchase
post
Check Apple SK2 purchase synchronization status
get
Vizio [Early Access]
post
Check Vizio purchase status [Early Access]
get
Authentication API
Getting Started With Authentication API
Hi5 Chatbot token
get
Device Login Flow (PIN Pair)
Generate code
post
Authorize code
post
Check code
get
JSON Web Key Set
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
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
getAccessStatus
Ask AI
