Skip to main content

​
Welcome to PayPulse

PayPulse is a subscription billing platform that handles invoicing, dunning, usage-based pricing, and secure payments. Base URL: https://api.paypulse.cv/api/v1

Quickstart

Get your first API call running in 2 minutes.

Authentication

Learn how to authenticate with API keys and JWT tokens.

API Reference

Full reference for every endpoint.

​
Core concepts

ConceptDescription
MerchantYour business account. Owns projects and API keys.
ProjectA logical grouping for plans, customers, and subscriptions.
PlanA pricing configuration — fixed or metered billing.
SubscriptionA customer’s active enrollment in a plan.
InvoiceA billing record generated each period.
Checkout SessionA hosted payment page for customers to subscribe.

​
Authentication

All API requests require either:
  • API key — passed as X-Api-Key header. Scopes to a project.
  • JWT token — passed as Authorization: Bearer <token>. Used for merchant management routes.
Some endpoints accept both (dual-auth). See Authentication for details.

​
Rate limits

  • 100 requests/second per API key
  • 1000 requests/minute per merchant
Rate limit headers are included in every response: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1690000000