Cancel additional licenses at period end

posthttps://api.expiryedge.com/v1/additionalLicensesCancel

admin60/minAny method

Request

curl -X POST 'https://api.expiryedge.com/v1/additionalLicensesCancel' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "acknowledge_overage": true
}'

Response

{
  "ok": true,
  "status": "active",
  "cancel_at_period_end": true
}

If the organization has more members than the base plan allows, returns 409 CANCEL_WILL_OVERFLOW_BASE unless acknowledge_overage: true is sent.

Body parameters

application/json

acknowledge_overageboolean

Returns

200

Cancellation scheduled.

okboolean
Allowedtrue
statusstring
Stripe subscription status.
cancel_at_period_endboolean
Allowedtrue

Errors

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`403`	Authenticated, but your role or organization does not allow this action.
`404`	The record does not exist or is not in your organization.
`409`	Cancelling would leave more members than base-plan seats.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.
`500`	Unexpected server error. Retry later; quote `requestId` to support.