Getting Started with SubsManager

This guide walks you through authenticating against the SubsManager API, configuring your application environments, and issuing your first request.

1. Authentication

All requests to the SubsManager B2B API require your application's private API Key. Send this key as a standard HTTP Bearer token inside the Authorization request header:

Authorization: Bearer ap_live_your_application_api_key

You can generate and view your API keys inside the SubsManager Dashboard → Applications → [Your App] → API Keys.

2. API Base URLs

All endpoints in the B2B surface reside under the /api/v1/ prefix.

3. Data & Communication Standards

• Payload Format: All request and response bodies use standard application/json; charset=utf-8.
• Timestamps: Dates and times are formatted as standard ISO 8601 strings in UTC (YYYY-MM-DDTHH:mm:ss.sssZ).
• Idempotency: Re-sending a request with the same client identifier or idempotency token ensures no duplicate charges or multiple subscriptions are initiated.
• Error Format: Unsuccessful API requests return structured JSON objects conforming to RFC 7807 problem details:

{
  "error": "Resource not found",
  "code": "RESOURCE_NOT_FOUND",
  "status": 404,
  "details": "Client with externalId 'usr_99182' does not exist"
}

4. Verification & Health Check

You can verify connectivity to the SubsManager platform using the public health endpoint:

curl -X GET https://subsmanager.vertueal.com/api/health

Response (200 OK):

{
  "status": "healthy",
  "timestamp": "2026-09-18T10:00:00.000Z",
  "uptime": 86420,
  "database": "connected"
}

5. Your First API Request

Fetch the active subscription plans configured for your tenant application:

curl -X GET "https://subsmanager.vertueal.com/api/v1/plans" \
  -H "Authorization: Bearer ap_live_your_api_key" \
  -H "Accept: application/json"

TypeScript / Node.js Example:

const response = await fetch('https://subsmanager.vertueal.com/api/v1/plans', {
  headers: {
    'Authorization': `Bearer ${process.env.SUBSMANAGER_API_KEY}`,
    'Accept': 'application/json',
  },
});

const data = await response.json();
console.log('Available subscription plans:', data.plans);