Release License

Releases licenses assigned to one or more entities.

POST /v1/licenses.release

Typescript (SDK)

TypeScript

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.licenses.release({
  customerId: "cus_123",
  licensePlanId: "seat_plan",
  entityIds: [
    "user_123",
  ],
});

200

{
  "success": true
}

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

entity_ids · string[] · required

Minimum array length: 1

license_plan_id · string

Scopes the release when an entity holds licenses of multiple plans.

Response

200 - application/json

OK

success · boolean · required