Billing API | ActiWAPI

Plans, subscriptions, Razorpay checkout, usage meters, and add-ons.

GET/api/billing/plans

List plans

Public catalog of subscription plans (no auth required).

URL: https://api.actiwapi.com/api/billing/plans

Auth: None

Code examples

curl -X GET "https://api.actiwapi.com/api/billing/plans" \
  -H "Content-Type: application/json"

Response example200

{
  "success": true,
  "data": [{
    "slug": "growth",
    "name": "Growth",
    "priceCents": 99900,
    "currency": "INR",
    "maxSessions": 5
  }]
}

Try in Swagger UI

GET/api/billing/subscription

Get subscription

Current subscription status, plan, and trial information.

URL: https://api.actiwapi.com/api/billing/subscription

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X GET "https://api.actiwapi.com/api/billing/subscription" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": {
    "status": "active",
    "plan": { "slug": "growth", "name": "Growth" },
    "currentPeriodEnd": "2026-06-30T00:00:00.000Z"
  }
}

Try in Swagger UI

GET/api/billing/usage

Get usage

Usage meters against plan limits.

URL: https://api.actiwapi.com/api/billing/usage

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X GET "https://api.actiwapi.com/api/billing/usage" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": {
    "sessions": { "used": 2, "limit": 5 },
    "apiRequests": { "used": 0, "limit": 100000 }
  }
}

Try in Swagger UI

POST/api/billing/checkout

Create checkout

Create a Razorpay order for plan upgrade or new subscription.

URL: https://api.actiwapi.com/api/billing/checkout

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{ "planSlug": "growth" }

Code examples

curl -X POST "https://api.actiwapi.com/api/billing/checkout" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{ "planSlug": "growth" }'

Response example200

{
  "success": true,
  "data": {
    "orderId": "order_xxx",
    "amount": 99900,
    "currency": "INR",
    "keyId": "rzp_test_xxx"
  }
}

Try in Swagger UI

POST/api/billing/verify-payment

Verify payment

Verify Razorpay payment signature after client-side checkout.

URL: https://api.actiwapi.com/api/billing/verify-payment

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{
  "razorpay_order_id": "order_xxx",
  "razorpay_payment_id": "pay_xxx",
  "razorpay_signature": "signature_xxx"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/billing/verify-payment" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{  "razorpay_order_id": "order_xxx",  "razorpay_payment_id": "pay_xxx",  "razorpay_signature": "signature_xxx"}'

Response example200

{ "success": true, "message": "Payment verified" }

Try in Swagger UI

POST/api/billing/cancel

Cancel subscription

Cancel auto-renewal at end of billing period.

URL: https://api.actiwapi.com/api/billing/cancel

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X POST "https://api.actiwapi.com/api/billing/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{ "success": true, "data": { "cancelAtPeriodEnd": true } }

Try in Swagger UI

POST/api/billing/addons/purchase

Purchase add-on

Purchase an add-on such as extra WhatsApp number or team seat.

URL: https://api.actiwapi.com/api/billing/addons/purchase

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{ "addonSlug": "additional_whatsapp_number", "quantity": 1 }

Code examples

curl -X POST "https://api.actiwapi.com/api/billing/addons/purchase" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{ "addonSlug": "additional_whatsapp_number", "quantity": 1 }'

Response example200

{ "success": true, "data": { "orderId": "order_xxx" } }

Try in Swagger UI

Error codes

Failed requests return a JSON envelope with success: false and a human-readable message.

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "phone": "Valid phone number is required"
  }
}

HTTP	Code	Description
400	VALIDATION_ERROR	Request body or query failed validation.
401	UNAUTHORIZED	Missing or invalid JWT / API key.
403	FORBIDDEN	Authenticated but lacking permission or entitlement.
403	SUBSCRIPTION_INACTIVE	Trial expired or subscription not active.
403	LIMIT_EXCEEDED	Plan limit reached (sessions, messages, API requests, etc.).
404	NOT_FOUND	Resource does not exist or is not in your tenant.
409	CONFLICT	Duplicate resource or invalid state transition.
429	RATE_LIMITED	Too many requests; retry after backoff.
500	INTERNAL_ERROR	Unexpected server error.
502	WHATSAPP_UNAVAILABLE	WhatsApp session disconnected or provider error.

← Back to Getting Started