API Documentation

Everything you need to integrate UpgradeFlow into your product. RESTful, well-documented, and developer-friendly.

Getting Started

Core Endpoints

Webhooks

SDKs

Introduction

The UpgradeFlow API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Base URL: https://api.upgradeflow.com/v1

Code Example

const response = await fetch(
  'https://api.upgradeflow.com/v1/status',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const data = await response.json();

const response = await fetch(
  'https://api.upgradeflow.com/v1/status',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const data = await response.json();

SDKs

Official Libraries

JavaScript

npm install @upgradeflow/sdk

View docs →

Python

pip install upgradeflow

View docs →

Ruby

gem install upgradeflow

View docs →

Go

go get github.com/upgradeflow/go-sdk

View docs →

Need help with the API?

Our developer support team is here to help. Reach out via email or join our Discord community.

Contact Support