Attach License

Assigns licenses to one or more entities.

POST /v1/licenses.attach

Typescript (SDK)

TypeScript

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.licenses.attach({
  customerId: "cus_123",
  planId: "seat_plan",
  entities: [
    {
      entityId: "user_123",
      name: "Ada Lovelace",
    },
  ],
});

200

{
  "success": true
}

License assignment is idempotent for an entity that already has an active assignment for the same license plan. Autumn skips those entities without consuming another license; mixed batches assign only unassigned entities. A duplicate-only request still returns 200 with { "success": true }. Duplicate IDs within one batch and insufficient capacity for new assignments still return an error.

Body Parameters

Response

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version · string · default: 2.4.0 · required

Body

application/json

customer_id · string · required

plan_id · string · required

entities · object[] · required

Minimum array length: 1

Show child attributes

Response

200 - application/json

OK

success · boolean · required