Jump to Content
App Dashboard
API Reference
App Dashboard
Log In
API Reference
Log In
API Reference
Overview
All
Pages
Start typing to search…
JUMP TO
Revenue HQ API
Introduction
Scopes
Authentication
Versioning
Email Notifications
Users
Overview
Retrieve the current user
get
Update the current user
patch
Create a 2FA confirmation code
post
Leave an application
del
Sessions
Create a session
post
Extend a session
put
API Tokens
Create a token
post
Retrieve all tokens
get
Delete a token
del
Enable a token
post
Disable a token
del
Applications
Overview
Create an application
post
Retrieve all applications
get
Retrieve an application
get
Update an application
patch
Update API version
put
Entitlements
Upsert an entitlement
post
Delete an entitlement
del
API Tokens
Create a token
post
Retrieve all tokens
get
Update a token
patch
Delete a token
del
Enable a token
post
Disable a token
del
Users
Add a user
post
Update a user
patch
Remove a user
del
Add a scope to a user
post
Remove a scope from a user
del
Transfer ownership
put
Payment Processing
Create an onboard link
post
Update payment status
put
Create an update link
post
Pricing
Overview
Periodicity
Plan Groups
Create a plan group
post
Retrieve all plan groups
get
Retrieve a plan group
get
Plans
Retrieve billing system default plan
get
Create a plan
post
Retrieve a plan
get
Update a plan
patch
Make a plan the default
post
Enable a plan
post
Disable a plan
del
Update a plan group
patch
Make a plan group the default
post
Retrieve billing system plan groups
get
Retrieve billing system default plan group
get
Discounts
Create a discount
post
Retrieve all discounts
get
Update a discount
patch
Offers
Create an offer
post
Retrieve all offers
get
Retrieve an offer
get
Update an offer
patch
Start an offer
post
End an offer
del
Offer Codes
Create offer codes
post
Retrieve all offer codes
get
Enable an offer code
post
Disable an offer code
del
Accounts
Leads
Create a lead
post
Subscribe
post
Unsubscribe
del
Overview
Verify account token
get
Create an account
post
Update the account email
put
Retrieve
Retrieve an account by id
get
Retrieve an account by email
get
Retrieve an account by id or email
get
Retrieve all accounts by email prefix
get
Retrieve recent accounts
get
Logging
Retrieve all audit logs
get
Create an account note
post
Payments
Retrieve all payments
get
Retrieve a payment
get
Refund a payment
post
Subscriptions
Retrieve all subscriptions
get
Retrieve a subscription
get
Retrieve the most recent subscription
get
Start a subscription
put
Cancel the active subscription
del
Uncancel the active subscription
post
Add a discount to the active subscription
post
Pause the active subscription
post
Upcoming Subscriptions
Retrieve the upcoming subscription
get
Update the upcoming subscription
patch
Delete the upcoming subscription
del
Add a discount to the upcoming subscription
post
Start the upcoming subscription
post
Credits
Add account credit
post
Remove account credit
post
Content
Landing Pages
Create a landing page
post
Landing Page Experiments
Update an experiment
put
Reset an experiment
post
Update a posterior
put
Retrieve all landing pages
get
Landing Page Versions
Create a version
post
Retrieve a version
get
Update a version
patch
Make a version the default
post
Enable a version
post
Disable a version
del
Retrieve a landing page
get
Update a landing page
patch
Make a landing page the default
post
Enable a landing page
post
Disable a landing page
del
Update robots.txt
put
Redirects
Upsert a redirect
post
Retrieve all redirects
get
Enable a redirect
post
Disable a redirect
del
Delete a redirect
del
Reverse Proxies
Upsert a reverse proxy
post
Retrieve all reverse proxies
get
Enable a reverse proxy
post
Disable a reverse proxy
del
Delete a reverse proxy
del
Sitemaps
Add a sitemap
post
Delete a sitemap
del
Messaging
Segments
Retrieve segments
get
Create a messaging segment
post
Retrieve a messaging segment
get
Update a messaging segment
patch
Email
Email Templates
Retrieve email templates
get
Create an email template
post
Retrieve an email template
get
Update an email template
patch
Archive an email template
del
Restore an email template
post
Email Campaigns
Retrieve email campaigns
get
Create an email campaign
post
Retrieve an email campaign
get
Archive an email campaign
del
Restore an email campaign
post
Powered by
Overview
Ask AI
Plan groups organize plans. And plans define the payment cycle via its periodicity.
