Charge and provision an activation

POST /api/v1/users/{id}/activation

Prices, charges and provisions in one operation. Funds are reserved first, then the plan is applied, and both halves are keyed off your request_id, so a retry after a crash re-runs neither the charge nor the grant.

The nested activation object is serialised with Go field names (UserID, NewSubscriptionEnd) and RFC3339 timestamps, unlike every other object on this API. Everything around it uses snake_case and yyyy-MM-dd HH:mm:ss. Do not write a parser that assumes one convention.

At a glance

Authentication: Staff token or session
Requires any one of: prm_users_activate prm_users_extend
Rate limit: t_mutate
Idempotency key: request_id

Parameters

Parameter	Description
`id`required path · integer	Subscriber id.
`request_id`required body · string	Idempotency key, up to 255 characters, no colon or pipe. Reuse the same one on every retry of one intent.
`money_collected` body · boolean	Defaults to true.
`card_code` body · string	Required when method is card. The voucher must be in the caller's subtree.
`issue_invoice` body · boolean	Also record an invoice document. Skipped on a replay so a retry never double-issues.

Errors

Code	When it is returned
`ERR_VALIDATION`400	request_id missing, too long, or in a reserved namespace
`ERR_CONFLICT`409	the request_id is already bound to an activation of a different subscriber
`ERR_FORBIDDEN`403	the body's operation needs a permission the caller does not hold

Request

curl -X POST "$BASE/api/v1/users/{id}/activation" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "profile_id": 7,
  "operation": "activate",
  "method": "manager_balance",
  "units": 1,
  "money_collected": true,
  "request_id": "0f3b9d4e-9a41-4c83-9b1e-2b6a0f1d88c2"
}'

Response 200 OK

{
  "data": {
    "quote": { "profile_id": 7, "required_amount": 171.00, "new_expiration": "2026-10-14 00:00:00" },
    "activation": {
      "UserID": 4711,
      "ProfileID": 7,
      "NewSubscriptionEnd": "2026-10-14T00:00:00Z",
      "BytesRemaining": 107374182400,
      "SecondsRemaining": -1,
      "PointsAwarded": 10,
      "QuotaCarried": false,
      "Replay": false
    },
    "manager_balance": 4029.00,
    "replay": false
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us