Identra Docs
Reference / Monetization

Subscribe (or move) an organization to a plan.

PUT /v1/organizations/{id}/subscription
Secret API key operationId: set_org_subscription

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    Organization id

Request body · required

  • plan_id string<uuid> required uuid
  • status string

    `active` (default) or `trialing`.

Responses

200 Subscribed
{
  "data": {
    "canceled_at": "2026-01-15T09:30:00Z",
    "currency": "string",
    "current_period_end": "2026-01-15T09:30:00Z",
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "interval": "string",
    "organization_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "organization_name": "string",
    "per_seat_cents": 0,
    "plan_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "plan_key": "string",
    "plan_name": "string",
    "price_cents": 0,
    "seats": 0,
    "status": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
404 No such organization
422 Unknown plan / bad status

Request

curl -X PUT "http://localhost:8080/v1/organizations/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/subscription" \
  -H "Content-Type: application/json" \
  -d '{
  "plan_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
  "status": "string"
}'

Try it

live request
PUT http://localhost:8080/v1/organizations/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/subscription

Path parameters

Request body

application/json