Husvo

API-referens

Planen

Husets plan, taken och provperioden för Plus.

Husets plan, gränserna som gäller och hur mycket som är använt

GET /api/v1/houses/{houseId}/plan

operationId getPlan

  • Bearer-token
  • Kräver läsrätt i huset

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1/plan" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · PlanDto
{
  "plan": "text",
  "enforced": false,
  "maxMembers": 1,
  "aiCallsPerMonth": 1,
  "pdfMarked": false,
  "canTransfer": false,
  "maxReceipts": 1,
  "members": 1,
  "aiUsed": 1,
  "receipts": 1,
  "maxFiles": 1,
  "files": 1,
  "contractWatch": false,
  "aiAssistant": false,
  "craftsmanLinks": false,
  "trialUntil": "2026-11-13T08:00:00Z",
  "trialUsed": false,
  "billing": {
    "status": "text",
    "period": "text",
    "amount": 1,
    "currentPeriodEnd": "2026-11-13T08:00:00Z",
    "cancelAtPeriodEnd": false,
    "renewsAt": "2026-11-13T08:00:00Z",
    "paymentFailed": false,
    "plusUntil": "2026-11-13T08:00:00Z"
  }
}

Fel, som problem+json (felkoderna):

  • 404Finns inte, eller inte för dig

Starta husets provperiod på Plus, 30 dagar. En gång per hus; 409 om den redan använts

POST /api/v1/houses/{houseId}/plan/trial

operationId startPlanTrial

  • Bearer-token
  • Kräver redigeringsrätt i huset
  • Skrivtaket gäller
  • Tar Idempotency-Key

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X POST "https://husvo.app/api/v1/houses/1/plan/trial" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Svar

200 Klart · PlanDto
{
  "plan": "text",
  "enforced": false,
  "maxMembers": 1,
  "aiCallsPerMonth": 1,
  "pdfMarked": false,
  "canTransfer": false,
  "maxReceipts": 1,
  "members": 1,
  "aiUsed": 1,
  "receipts": 1,
  "maxFiles": 1,
  "files": 1,
  "contractWatch": false,
  "aiAssistant": false,
  "craftsmanLinks": false,
  "trialUntil": "2026-11-13T08:00:00Z",
  "trialUsed": false,
  "billing": {
    "status": "text",
    "period": "text",
    "amount": 1,
    "currentPeriodEnd": "2026-11-13T08:00:00Z",
    "cancelAtPeriodEnd": false,
    "renewsAt": "2026-11-13T08:00:00Z",
    "paymentFailed": false,
    "plusUntil": "2026-11-13T08:00:00Z"
  }
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig
  • 409Krockar med något som redan finns
Sidan hakade upp sig.Ladda om🗙