Skip to main content

Subscriptions

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

12 endpoints.

POST /subscription​

Create subscription.

Auth apikey

DELETE /subscription/:subscriptionId​

Remove specific subscription.

Auth apikey · Success 200

:::note Used by the web app pages/Billing.jsx, pages/BillingHistory.jsx, pages/MyPlanDetails.jsx and 1 more :::

Path parameters

Name
subscriptionIdRequired

Response — data is one ResponseMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SubscriptionNotFound_400

POST /subscription/change​

Change subscription.

Auth apikey · Success 200

Errors PlanMaxUsers_400 · PlanMinUsers_400

DELETE /subscription/current​

Remove current subscription.

Auth apikey · Success 200

Response — data is one Subscription object. planDetails.features.feature changeRequest is populated, so it arrives as nested objects rather than ids.

Errors SubscriptionNotFound_400

GET /subscription/history​

Get subscription history.

Auth apikey

GET /subscription/list​

Get all subscriptions.

Auth apikey

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

POST /subscription/preview​

Price a plan change before committing to it.

Auth apikey

Response — data is one ResponseMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors PlanMaxUsers_400

DELETE /subscription/queued​

Remove all queued subscriptions.

Auth apikey · Success 200

DELETE /subscription/queued/:subscriptionId​

Remove queued subscription.

Auth apikey · Success 200

Path parameters

Name
subscriptionIdRequired

POST /subscription/seats/change​

Change seat upgrade.

Auth apikey · Success 200

:::note Used by the web app pages/SeatManagement.jsx :::

Errors SubscriptionNotFound_400

POST /subscription/seats/preview​

Price a seat change before committing to it.

Auth apikey

:::note Used by the web app pages/SeatManagement.jsx :::

GET /subscription/upcoming​

Get upcoming subscription changes.

Auth apikey