Shipflash logoDocs

API

The API surface covers health checks, auth, analytics, contact, billing, webhooks, waitlist, scheduler, cron, and admin billing tasks.

CategoryMethodPathPurpose
HealthGET/api/healthDeployment and uptime probe.
HealthGET/api/health/readyDatabase readiness probe.
AuthGET/api/auth/meReturn the current authenticated profile.
AnalyticsGET/api/analytics/platform/rangeLoad platform metrics for a bounded range.
AnalyticsGET/api/analytics/revenue/rangeLoad revenue metrics for a bounded range.
BillingPOST/api/billing/checkoutCreate a provider checkout session.
BillingPOST/api/billing/portalCreate a customer portal session.
BillingGET/api/billing/statusReturn customer billing status.
ContactPOST/api/contactValidate, rate-limit, and store a contact message.
CronGET/api/cron/data-retentionRun protected operational cleanup.
CronGET/api/cron/notification-outboxProcess a protected notification batch.
NotificationsPOST/api/notifications/webhooks/resendApply verified Resend delivery updates.
SchedulerPOST/api/scheduler/publishPublish scheduled content.
Billing adminPOST/api/system/billing/customers/[providerCustomerId]/syncRefresh supported provider customer state.
Billing adminGET/api/system/billing/exportExport guarded billing records.
Billing adminPOST/api/system/billing/refundsCreate a guarded provider refund.
Billing adminPATCH/api/system/billing/subscriptions/[providerSubscriptionId]Apply a guarded subscription operation.
WaitlistGET/api/waitlist/confirmConfirm a double-opt-in token.
WaitlistGET/api/waitlist/exportExport guarded waitlist records.
WaitlistPOST/api/waitlist/signupValidate and store a public signup.
WebhooksPOST/api/webhooks/lemonsqueezyVerify and process Lemon Squeezy events.
WebhooksPOST/api/webhooks/stripe/billingVerify and process Stripe billing events.