Skip to main content

Documentation Index

Fetch the complete documentation index at: https://spreesuite.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Platforms (or Integrations) represent the external systems that BillSpree communicates with to provision services or sync data.

Provisioning Logic

When a customer subscribes to a product, BillSpree can automatically notify an external platform to “turn on” the service. This is typically done via:
  • Webhooks: BillSpree sends an HTTP request to your application.
  • API Connectors: Direct integration with services like AWS, Stripe, or custom internal systems.

Configuration

  1. Go to BillSpree → Settings → Platforms.
  2. Register your external system with its API endpoint and authentication credentials.
  3. Link the platform to specific Pricing Templates.

Lifecycle Events

BillSpree sends notifications for various subscription events:
  • Created: Provision the service for the new user.
  • Updated: Adjust resource limits based on a plan change.
  • Cancelled: Suspend or delete the service.
  • Payment Failed: Optionally restrict access until the bill is paid.

Multi-tenant Support

If your application is multi-tenant, BillSpree can pass the Tenant ID or Organization ID in all communications, ensuring the correct account is updated in your platform.