API Reference | Prolifi | Documentation

The Prolifi Public API lets you integrate subscription billing, customer management, usage metering, and entitlement checks directly into your application.

Base URL

https://api.prolifi.co/api/v1/public

Quick start

Generate API keys from the Prolifi dashboard (Settings > API Keys)
Use your secret key (sk_test_*) for server-side integrations
Make your first request:

$ curl https://api.prolifi.co/api/v1/public/plans \
>   -H "Authorization: Bearer sk_test_your_key_here"

Resources

Authentication

API key types, environments, and security

Errors

Error format, types, and handling guidance

Pagination

Offset-based pagination for list endpoints

Rate Limiting

Request limits, headers, and retry strategies

Idempotency

Safely retry requests without duplicating operations

IP Whitelisting

Restrict API access to specific IP addresses

API endpoints

The API is organized around six resource types:

Resource	Endpoints	Description
Plans	`GET /plans`, `GET /plans/{id}`	Browse the product catalog (read-only)
Customers	`POST`, `GET`, `PATCH`, `DELETE /customers`	Manage customer records
Subscriptions	`POST`, `GET`, `PATCH`, `DELETE /subscriptions`	Create and manage subscriptions
Invoices	`GET /invoices`, `POST /invoices/{id}/finalize`, `POST /invoices/{id}/void`	Invoice management
Usage Events	`POST /events`, `POST /events/batch`, `GET /customers/{id}/usage`	Usage-based billing
Entitlements	`POST /entitlements/check`, `GET /customers/{id}/entitlements`	Feature access and metering

Browse the full endpoint reference in the sidebar, or refer to the Developers getting started guide for integration architecture and webhook events.