Getting Started

Overview

Pharos is a payments and billing platform with a hosted checkout flow, reusable payment links, and an authenticated REST API for business-scoped integrations.

Use this path when you want to:

• authenticate with an API key
• list products and prices
• create or manage payment links
• send buyers from your site into hosted checkout
• receive webhook events on your backend

Authentication

All /api/v1 endpoints require the x-api-key header.

curl -H 'x-api-key: YOUR_API_KEY' \
  http://localhost:3000/api/v1/products

Create and manage keys from the Pharos backoffice developers settings.

Suggested First Flow

1. Confirm your API key works by listing products.
2. Retrieve the product and price IDs you want to expose.
3. Create or update a payment link for that offer.
4. Add the hosted payment link URL to your site or campaign.
5. Subscribe to webhook events before moving to production.

Core Guides

• Find your Collections use case
• Use Payment Links
• Build a dynamic cart with Checkout Sessions
• Handle Collections Webhooks
• API Reference
• Checkout Concepts

Key Concepts

Products

Products and prices define what your buyers can purchase.

Use the Products endpoints in the API reference to fetch the catalog exposed to your integration.

Payment Links

Payment Links are reusable hosted checkout URLs. When hosted checkout initializes, Pharos creates or resumes a concrete Checkout Session that snapshots the link.

Use payment links when you want to keep your own site or app and hand off the billing flow to Pharos.

Webhooks

Use webhooks to react to checkout, payment, and subscription events in your own backend.

Pharos signs deliveries with x-pharos-signature, and your webhook consumer should handle duplicate deliveries safely. Fulfill only after the signed purchase_succeeded event.