Skip to main content

How to use the Subi API to manage contracts and subscriptions

Learn how to use the Subi API to programmatically create, update, retrieve, and delete contract and subscription data, and integrate Subi with your internal tools or systems.

Updated over 2 months ago

Overview

The Subi API allows developers and technical teams to manage contracts and subscriptions programmatically. This is ideal for integrating Subi with internal systems, external tools, data warehouses, or custom applications.

With the API, you can automate subscription workflows and keep contract data in sync across platforms.

What You Can Do with the Subi API

Using the Subi API, you can:

  • Retrieve contract and subscription data

  • Create new contracts programmatically

  • Update existing contract details

  • Delete contracts when needed

  • Sync subscription data with external platforms

Who it's for: This feature is intended for developers and technical users who want full programmatic control over contract and subscription data.



How to Generate an API Key

To access the Subi API, you’ll need to generate an API key from your Subi dashboard.


Steps to generate your API key:

  1. Log in to your Subi dashboard.

  2. Go to Settings.

  3. Click on API keys.

  4. Select Generate API key.

  5. Copy and securely store your API key.

⚠️ Important: Keep your API key confidential. Do not share it publicly or expose it in any client-side code.

API Key Management Screen

This image shows the API Keys section in the Subi dashboard, where you can generate and manage keys to connect with external systems.

Authenticating API Requests

All API requests must include your API key in the request headers.

Refer to the Subi API Documentation for the correct header format and detailed usage examples.

Where to Find Full API Documentation

For technical specifications, available endpoints, example requests/responses, and authentication details, visit the official API docs:

Need Help?

If you need assistance with the API or have questions about your integration, contact the Subi support team or explore other developer articles in our Help Center.

Did this answer your question?