API Documentation

Use the BlueHill Payments API to manage subscriptions, setup payment orchestration, billing and more.

Getting started

To get started, create a new application in your developer settings, then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs. When your integration is ready to go live, publish it to our integrations directory to reach the BlueHill community.

Guides

Basic Usage

Learn how to create your first API requests and workflow with BlueHill.

Read About Basic Usage

Customers

Understand how to work with the Customer resource.

Read About Customers

Products

Read about the different ways to setup your products.

Read About Products

Transactions

Learn how to programmatically charge your customers.

Read About Transactions

Resources

Customers

Learn about the contact model and how to create, retrieve, update, delete, and list contacts.

Payment Methods

Learn about the conversation model and how to create, retrieve, update, delete, and list conversations.

Transactions

Learn about the message model and how to create, retrieve, update, delete, and list messages.

Levels

Learn about the group model and how to create, retrieve, update, delete, and list groups.