Billing

The PropZolo subscription (plans, seats, checkout, proration), GST invoices, prepaid wallets, the onboarding checklist and support-access grants.

GET/v1/billing

Plan, seats and payment status

Access: API key or member session. Permission billing.view.

Response · 200

datarequired: BillingOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/billing' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "payments_configured": true,
    "invoicing_configured": true,
    "test_mode": true,
    "company_status": "trial",
    "read_only": true,
    "seats_used": 0,
    "subscription": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "plan_code": "string",
      "plan_name": "string",
      "status": "trialing",
      "cycle": "monthly",
      "seats": 0,
      "trial_ends_at": "2026-10-06T05:30:00.000Z",
      "current_period_start": "2026-10-06T05:30:00.000Z",
      "current_period_end": "2026-10-06T05:30:00.000Z",
      "cancel_at_period_end": true,
      "gateway": "string",
      "gateway_status": "string",
      "period_amount": {
        "taxable": 850000000,
        "gst": 850000000,
        "gross": 850000000
      },
      "pending_change": {
        "kind": "checkout",
        "plan_code": "string",
        "cycle": "monthly",
        "seats": 0,
        "effective_at": "2026-10-06T05:30:00.000Z",
        "checkout_url": "string"
      }
    },
    "dunning": {
      "past_due_at": "2026-10-06T05:30:00.000Z",
      "days_overdue": 0,
      "suspends_at": "2026-10-06T05:30:00.000Z",
      "cancels_at": "2026-10-06T05:30:00.000Z"
    },
    "emandate_required": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/billing/checkout

Start a paid subscription

Creates the Razorpay subscription and returns its hosted checkout link (cards, UPI AutoPay, e-mandate). During a trial the first charge is scheduled for the trial end. 409 when a paid subscription already runs (use change).

Access: Signed-in members only (web or Android session) — not for API keys. Permission billing.manage.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

plan_coderequired: string
cyclerequired: "monthly" | "yearly"
seatsrequired: integer

Response · 200

datarequired: CheckoutResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/billing/checkout' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"plan_code":"string","cycle":"monthly","seats":1}'

Response example

{
  "data": {
    "checkout_url": "string",
    "gateway_subscription_id": "string",
    "period_amount": {
      "taxable": 850000000,
      "gst": 850000000,
      "gross": 850000000
    },
    "starts_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/billing/invoices

GST invoices and credit notes

Access: API key or member session. Permission billing.view.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.

Response · 200

datarequired: array of PlatformInvoice
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/billing/invoices' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "kind": "subscription",
      "status": "string",
      "subtotal": 850000000,
      "cgst": 850000000,
      "sgst": 850000000,
      "igst": 850000000,
      "total": 850000000,
      "place_of_supply": "string",
      "gstin": "string",
      "issued_at": "2026-10-06T05:30:00.000Z",
      "paid_at": "2026-10-06T05:30:00.000Z",
      "credit_note_for": "string",
      "document_url": "string"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/billing/invoices/{id}/document

Printable invoice (HTML)

A print-ready HTML page (Print → Save as PDF). Another company’s invoice is 404.

Access: API key or member session. Permission billing.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/billing/invoices/{id}/document' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/billing/plans

Plans on sale

Access: API key or member session. Permission billing.view.

Response · 200

datarequired: array of BillingPlan
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/billing/plans' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "code": "string",
      "name": "string",
      "description": "string",
      "model": "free",
      "cycles": [
        "monthly"
      ],
      "price_monthly": 850000000,
      "price_yearly": 850000000,
      "min_seats": 0,
      "included_seats": 0,
      "extra_seat_monthly": 850000000,
      "purchasable": true
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/billing/subscription/cancel

Cancel at the period end

Access: Signed-in members only (web or Android session) — not for API keys. Permission billing.manage.

Request body

reason: string

Response · 200

datarequired: SubscriptionSummary
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/billing/subscription/cancel' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "plan_code": "string",
    "plan_name": "string",
    "status": "trialing",
    "cycle": "monthly",
    "seats": 0,
    "trial_ends_at": "2026-10-06T05:30:00.000Z",
    "current_period_start": "2026-10-06T05:30:00.000Z",
    "current_period_end": "2026-10-06T05:30:00.000Z",
    "cancel_at_period_end": true,
    "gateway": "string",
    "gateway_status": "string",
    "period_amount": {
      "taxable": 850000000,
      "gst": 850000000,
      "gross": 850000000
    },
    "pending_change": {
      "kind": "checkout",
      "plan_code": "string",
      "cycle": "monthly",
      "seats": 0,
      "effective_at": "2026-10-06T05:30:00.000Z",
      "checkout_url": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/billing/subscription/change

Change plan, seats or billing cycle

Upgrades and seat increases apply now; their prorated difference is added to the next charge. Decreases, downgrades and cycle switches apply at the period end. Seats cannot go below the active members.

Access: Signed-in members only (web or Android session) — not for API keys. Permission billing.manage.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

plan_coderequired: string
cyclerequired: "monthly" | "yearly"
seatsrequired: integer

Response · 200

datarequired: SubscriptionChangeResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/billing/subscription/change' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"plan_code":"string","cycle":"monthly","seats":1}'

Response example

{
  "data": {
    "kind": "upgrade",
    "charge_now": {
      "taxable": 850000000,
      "gst": 850000000,
      "gross": 850000000
    },
    "effective_at": "2026-10-06T05:30:00.000Z",
    "payment_url": "string",
    "subscription": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "plan_code": "string",
      "plan_name": "string",
      "status": "trialing",
      "cycle": "monthly",
      "seats": 0,
      "trial_ends_at": "2026-10-06T05:30:00.000Z",
      "current_period_start": "2026-10-06T05:30:00.000Z",
      "current_period_end": "2026-10-06T05:30:00.000Z",
      "cancel_at_period_end": true,
      "gateway": "string",
      "gateway_status": "string",
      "period_amount": {
        "taxable": 850000000,
        "gst": 850000000,
        "gross": 850000000
      },
      "pending_change": {
        "kind": "checkout",
        "plan_code": "string",
        "cycle": "monthly",
        "seats": 0,
        "effective_at": "2026-10-06T05:30:00.000Z",
        "checkout_url": "string"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/billing/wallets

Wallet balances and rate card

Access: API key or member session. Permission billing.view.

Response · 200

datarequired: WalletsOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/billing/wallets' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "payments_configured": true,
    "rate_card": {
      "sms_segment_paise": 0,
      "whatsapp_message_paise": 0,
      "email_paise": 0,
      "ai_credit_paise": 0,
      "min_topup_rupees": 0,
      "max_topup_rupees": 0
    },
    "wallets": [
      {
        "kind": "sms",
        "unit": "paise",
        "exists": true,
        "balance": 0,
        "reserved": 0,
        "available": 0,
        "low_balance_alert": 0,
        "low_balance": true,
        "disabled": true,
        "updated_at": "2026-10-06T05:30:00.000Z",
        "allowance": {
          "amount": 0,
          "per_user": 0,
          "seats": 0,
          "trial": true,
          "next_at": "2026-10-06T05:30:00.000Z"
        }
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/billing/wallets/transactions

Wallet ledger

Access: API key or member session. Permission billing.view.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
kindquery: "sms" | "whatsapp" | "ai" | "voice" | "email"
reasonquery: "topup" | "message" | "ai" | "voice" | "refund" | "plan_grant" | …
fromquery: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
toquery: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Response · 200

datarequired: array of WalletTransaction
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/billing/wallets/transactions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "sms",
      "amount": 0,
      "balance_after": 0,
      "reason": "string",
      "ref_type": "string",
      "ref_id": "string",
      "note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/billing/wallets/{kind}

Set the low-balance alert

Access: Signed-in members only (web or Android session) — not for API keys. Permission billing.wallet.

Parameters

kindpathrequired: "sms" | "whatsapp" | "ai" | "voice" | "email"

Request body

low_balance_alertrequired: integer or null
Alert below this many units (paise or credits); null switches the alert off.

Response · 200

datarequired: Wallet
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/billing/wallets/{kind}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"low_balance_alert":0}'

Response example

{
  "data": {
    "kind": "sms",
    "unit": "paise",
    "exists": true,
    "balance": 0,
    "reserved": 0,
    "available": 0,
    "low_balance_alert": 0,
    "low_balance": true,
    "disabled": true,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "allowance": {
      "amount": 0,
      "per_user": 0,
      "seats": 0,
      "trial": true,
      "next_at": "2026-10-06T05:30:00.000Z"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/billing/wallets/{kind}/top-up

Top up a wallet

Returns a Razorpay payment link for the top-up plus 18 % GST; the wallet is credited when the payment arrives (webhook) and a tax invoice is issued. Credits are closed-loop: usable only for PropZolo services.

Access: Signed-in members only (web or Android session) — not for API keys. Permission billing.wallet.

Parameters

kindpathrequired: "sms" | "whatsapp" | "ai" | "voice" | "email"
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

amount_rupees: integer
Messaging wallets.
credits: integer
The AI wallet.

Response · 200

datarequired: WalletTopUpResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/billing/wallets/{kind}/top-up' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"amount_rupees":1,"credits":1}'

Response example

{
  "data": {
    "checkout_url": "string",
    "payment_link_id": "string",
    "kind": "sms",
    "credits": 0,
    "amount": {
      "taxable": 850000000,
      "gst": 850000000,
      "gross": 850000000
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/onboarding

Onboarding checklist

Computed from the workspace’s real data on every call.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.view.

Response · 200

datarequired: Onboarding
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/onboarding' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "items": [
      {
        "key": "company_profile",
        "label": "string",
        "description": "string",
        "href": "string",
        "done": true
      }
    ],
    "completed": 0,
    "total": 0,
    "dismissed": true,
    "can_dismiss": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/onboarding

Hide or show the checklist

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.company.

Request body

dismissedrequired: boolean

Response · 200

datarequired: Onboarding
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/onboarding' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"dismissed":true}'

Response example

{
  "data": {
    "items": [
      {
        "key": "company_profile",
        "label": "string",
        "description": "string",
        "href": "string",
        "done": true
      }
    ],
    "completed": 0,
    "total": 0,
    "dismissed": true,
    "can_dismiss": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/support-access

Support-access grants and sessions

Access: Signed-in members only (web or Android session) — not for API keys. Permission privacy.support_access.

Response · 200

datarequired: SupportAccess
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/support-access' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "grants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "mode": "read",
        "reason": "string",
        "status": "active",
        "granted_by_id": "cmusrceel0000q7kaafxqi1om",
        "granted_to": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "sessions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "grant_id": "cmusrceel0000q7kaafxqi1om",
        "agent": "string",
        "mode": "read",
        "started_at": "2026-10-06T05:30:00.000Z",
        "ended_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "end_reason": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/support-access

Let PropZolo support in

Time-boxed (≤ 72 h), read-only by default; every action support takes is audited with both identities.

Access: Signed-in members only (web or Android session) — not for API keys. Permission privacy.support_access.

Request body

reasonrequired: string
hoursrequired: integer
mode: "read" | "full"

Response · 201

datarequired: SupportGrant
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/support-access' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string","hours":1,"mode":"read"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "mode": "read",
    "reason": "string",
    "status": "active",
    "granted_by_id": "cmusrceel0000q7kaafxqi1om",
    "granted_to": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/support-access/{id}/revoke

Revoke support access

Ends the grant and every support session on it at once.

Access: Signed-in members only (web or Android session) — not for API keys. Permission privacy.support_access.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SupportGrant
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/support-access/{id}/revoke' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "mode": "read",
    "reason": "string",
    "status": "active",
    "granted_by_id": "cmusrceel0000q7kaafxqi1om",
    "granted_to": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "payments_configured": true, "invoicing_configured": true, "test_mode": true, "company_status": "trial", "read_only": true, "seats_used": 0, "subscription": { "id": "cmusrceel0000q7kaafxqi1om", "plan_code": "string", "plan_name": "string", "status": "trialing", "cycle": "monthly", "seats": 0, "trial_ends_at": "2026-10-06T05:30:00.000Z", "current_period_start": "2026-10-06T05:30:00.000Z", "current_period_end": "2026-10-06T05:30:00.000Z", "cancel_at_period_end": true, "gateway": "string", "gateway_status": "string", "period_amount": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 }, "pending_change": { "kind": "checkout", "plan_code": "string", "cycle": "monthly", "seats": 0, "effective_at": "2026-10-06T05:30:00.000Z", "checkout_url": "string" } }, "dunning": { "past_due_at": "2026-10-06T05:30:00.000Z", "days_overdue": 0, "suspends_at": "2026-10-06T05:30:00.000Z", "cancels_at": "2026-10-06T05:30:00.000Z" }, "emandate_required": true }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/billing/checkout' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"plan_code":"string","cycle":"monthly","seats":1}'

{ "data": { "checkout_url": "string", "gateway_subscription_id": "string", "period_amount": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 }, "starts_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "kind": "subscription", "status": "string", "subtotal": 850000000, "cgst": 850000000, "sgst": 850000000, "igst": 850000000, "total": 850000000, "place_of_supply": "string", "gstin": "string", "issued_at": "2026-10-06T05:30:00.000Z", "paid_at": "2026-10-06T05:30:00.000Z", "credit_note_for": "string", "document_url": "string" } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": [ { "code": "string", "name": "string", "description": "string", "model": "free", "cycles": [ "monthly" ], "price_monthly": 850000000, "price_yearly": 850000000, "min_seats": 0, "included_seats": 0, "extra_seat_monthly": 850000000, "purchasable": true } ], "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "plan_code": "string", "plan_name": "string", "status": "trialing", "cycle": "monthly", "seats": 0, "trial_ends_at": "2026-10-06T05:30:00.000Z", "current_period_start": "2026-10-06T05:30:00.000Z", "current_period_end": "2026-10-06T05:30:00.000Z", "cancel_at_period_end": true, "gateway": "string", "gateway_status": "string", "period_amount": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 }, "pending_change": { "kind": "checkout", "plan_code": "string", "cycle": "monthly", "seats": 0, "effective_at": "2026-10-06T05:30:00.000Z", "checkout_url": "string" } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/billing/subscription/change' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"plan_code":"string","cycle":"monthly","seats":1}'

{ "data": { "kind": "upgrade", "charge_now": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 }, "effective_at": "2026-10-06T05:30:00.000Z", "payment_url": "string", "subscription": { "id": "cmusrceel0000q7kaafxqi1om", "plan_code": "string", "plan_name": "string", "status": "trialing", "cycle": "monthly", "seats": 0, "trial_ends_at": "2026-10-06T05:30:00.000Z", "current_period_start": "2026-10-06T05:30:00.000Z", "current_period_end": "2026-10-06T05:30:00.000Z", "cancel_at_period_end": true, "gateway": "string", "gateway_status": "string", "period_amount": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 }, "pending_change": { "kind": "checkout", "plan_code": "string", "cycle": "monthly", "seats": 0, "effective_at": "2026-10-06T05:30:00.000Z", "checkout_url": "string" } } }, "meta": {} }

{ "data": { "payments_configured": true, "rate_card": { "sms_segment_paise": 0, "whatsapp_message_paise": 0, "email_paise": 0, "ai_credit_paise": 0, "min_topup_rupees": 0, "max_topup_rupees": 0 }, "wallets": [ { "kind": "sms", "unit": "paise", "exists": true, "balance": 0, "reserved": 0, "available": 0, "low_balance_alert": 0, "low_balance": true, "disabled": true, "updated_at": "2026-10-06T05:30:00.000Z", "allowance": { "amount": 0, "per_user": 0, "seats": 0, "trial": true, "next_at": "2026-10-06T05:30:00.000Z" } } ] }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "sms", "amount": 0, "balance_after": 0, "reason": "string", "ref_type": "string", "ref_id": "string", "note": "string", "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": { "kind": "sms", "unit": "paise", "exists": true, "balance": 0, "reserved": 0, "available": 0, "low_balance_alert": 0, "low_balance": true, "disabled": true, "updated_at": "2026-10-06T05:30:00.000Z", "allowance": { "amount": 0, "per_user": 0, "seats": 0, "trial": true, "next_at": "2026-10-06T05:30:00.000Z" } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/billing/wallets/{kind}/top-up' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"amount_rupees":1,"credits":1}'

{ "data": { "checkout_url": "string", "payment_link_id": "string", "kind": "sms", "credits": 0, "amount": { "taxable": 850000000, "gst": 850000000, "gross": 850000000 } }, "meta": {} }

{ "data": { "items": [ { "key": "company_profile", "label": "string", "description": "string", "href": "string", "done": true } ], "completed": 0, "total": 0, "dismissed": true, "can_dismiss": true }, "meta": {} }

{ "data": { "grants": [ { "id": "cmusrceel0000q7kaafxqi1om", "mode": "read", "reason": "string", "status": "active", "granted_by_id": "cmusrceel0000q7kaafxqi1om", "granted_to": "string", "created_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z" } ], "sessions": [ { "id": "cmusrceel0000q7kaafxqi1om", "grant_id": "cmusrceel0000q7kaafxqi1om", "agent": "string", "mode": "read", "started_at": "2026-10-06T05:30:00.000Z", "ended_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "end_reason": "string" } ] }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "mode": "read", "reason": "string", "status": "active", "granted_by_id": "cmusrceel0000q7kaafxqi1om", "granted_to": "string", "created_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }