Skip to main content
REST API · JWT Auth · Webhooks

Build on Subscriply

Full REST API across all modules — subscriptions, customers, AI, campaigns, reports. JWT-secured, tenant-isolated, and built for modern SaaS at scale.

curl
curl -X POST https://api.subscriply.com/subscriptions/subscribeCustomerToPlan \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 42,
    "planId": 7,
    "frequencyId": 2,
    "startDate": "2026-06-15",
    "applyProration": true
  }'
View API Reference

JWT Auth

Role + permission enforcement on every endpoint.

AI Endpoints

Generate templates and campaigns via API.

Webhooks

Event webhooks for lifecycle and payment events.

File Upload

CSV/XLSX bulk import for customers and plans.

API Reference

All endpoints confirmed in codebase. Base URL: https://api.subscriply.com · All requests require Authorization: Bearer <token>

Authentication

3 endpoints
POST/auth/login
POST/auth/logout
POST/auth/register

Subscriptions & Plans

9 endpoints
POST/subscriptions/subscribeCustomerToPlan
GET/subscriptions/allSubscriptions
GET/subscriptions/getSubscriptionById/:id
POST/subscriptions/updateSubscription
POST/subscriptions/updateSubscriptionStatus
POST/subscriptions/plans
POST/subscriptions/getAllPlanByTenantId
POST/subscriptions/createPricingModel
POST/subscriptions/generateInvoice

Customers

4 endpoints
GET/customers/getAllCustomersByTenantId
POST/customers/createCustomer
POST/customers/updateCustomer
GET/customers/getCustomerById/:id

Payments

3 endpoints
GET/payment/getPaymentsByTenantId
POST/payment/initiatePayment
POST/payment/recordOfflinePayment

Reports & Analytics

7 endpoints
GET/reports/mrr
GET/reports/arr
GET/reports/arpa
GET/reports/collections
GET/reports/lifecycle
GET/dashboard
POST/dashboard/save

Dunning Campaigns

4 endpoints
POST/campaign/createCampaign
GET/campaign/getAllCampaignsByTenantId
GET/campaign/getCampaignById/:id
POST/campaign/updateCampaignById

AI Features

6 endpoints
POST/assistant/assistant/query
POST/assistant/templates/generate
POST/assistant/templates/enhance
POST/assistant/templates/enhance-section
POST/assistant/templates/classify-intent
POST/assistant/campaign/generate

Themes & Settings

6 endpoints
GET/theme/getThemesByTenantId
POST/theme/createTheme
GET/notification
POST/fileupload
GET/businessInfo
POST/businessInfo

Example: Create Subscription

Request

POST/subscriptions/subscribeCustomerToPlan
curl -X POST https://api.subscriply.com/subscriptions/subscribeCustomerToPlan \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 42,
    "planId": 7,
    "frequencyId": 2,
    "startDate": "2026-06-15",
    "applyProration": true
  }'

Response

200 OK
{
  "success": true,
  "data": {
    "subscriptionId": 1234,
    "status": "active",
    "planName": "Growth",
    "nextBillingDate": "2026-07-15",
    "amount": 9999,
    "currency": "USD",
    "gstBreakdown": {
      "cgst": 719.91,
      "sgst": 719.91,
      "total": 9438.82
    }
  }
}

Getting started

1

Sign up for free

Create your account and complete onboarding. API credentials are available immediately.

2

Authenticate

POST to /auth/login with your credentials. Include the JWT as a Bearer token on all requests.

3

First API call

GET /subscriptions/allSubscriptions to verify connectivity. Explore the reference above.

Postman Collection

A full Postman collection with all endpoints pre-configured is available in the product. Go to Settings → Developer → Download Collection.

Webhook event catalog

All events are delivered via HTTPS POST with HMAC-SHA256 signature verification.

subscription.created

New subscription started

subscription.updated

Plan changed, proration applied

subscription.cancelled

Subscription cancelled or expired

invoice.created

Invoice generated for billing cycle

invoice.paid

Payment collected successfully

invoice.failed

Payment attempt failed

payment.success

Payment confirmed

payment.failed

Payment declined or timed out

customer.created

New customer profile created

customer.updated

Customer details modified

Sandbox & test mode

Every account includes a full sandbox environment with isolated test data, separate API keys, mock payment responses, and test webhook delivery — so you can build and verify integrations before going live.

Separate API keys

Sandbox keys are prefixed sk_test_ and never affect live data.

Mock payment responses

Trigger success, failure, and retry scenarios without real transactions.

Test webhook delivery

Sandbox webhooks fire to your endpoint so you can verify event handling end-to-end.

Isolated test data

Customers, subscriptions, and invoices created in sandbox stay separate from production.

SDK roadmap

Official SDKs in active development.

Node.jsComing soon
PythonComing soon
JavaComing soon
GoComing soon
PHPComing soon
RubyComing soon

Rate limits

Standard rate limits apply to all API keys.

Standard rate100 requests / second
Burst limit200 requests
Rate exceeded responseHTTP 429 Too Many Requests
Retry guidanceRetry-After header included
For startups & scale-ups

Ready to build on Subscriply?

Get your API key today. Full REST API, AI endpoints, webhooks, and SDK roadmap — built for modern SaaS at scale.

Book a Demo

No credit card required · 14-day free trial · Cancel anytime

Enterprise

Need a custom plan?

Volume pricing, custom contracts, dedicated onboarding, SSO, audit logs, and a 99.97% uptime SLA — built for teams that need more.

  • Custom contract & invoicing
  • Dedicated onboarding & support
  • SSO / SAML integration
  • Audit logs & access controls
  • Priority SLA & uptime guarantee
Contact Enterprise Sales