Skip to content

Deel: Retrieve the IT seat subscription

Deel itSeats.retrieveTheItSeatContract: arguments, response, policy and SDK examples.

← IT seats operations · Get started

Operation deel.itseats_retrievetheitseatcontract_v2026_09_25

Provider route: GET /it/seats/status. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["itSeats"]["retrieveTheItSeatContract"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.itSeats.retrieveTheItSeatContract(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.it_seats.retrieve_the_it_seat_contract(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve the IT seat subscription — 200 response body

Referenced models: Retrieve the IT seat subscription — 200 response body

Retrieve the IT seat subscription — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data

Referenced models: Retrieve the IT seat subscription — 200 response body — data

Retrieve the IT seat subscription — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
assigned_seatsJSONRequired within parent
assigned_seats (anyOf 1)integerAlternativeNumber of seats held by a worker, whether or not the seat's paid features are in use yet.
Format: int64
assigned_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
available_seatsJSONRequired within parent
available_seats (anyOf 1)integerAlternativeNumber of paid seats free to assign right now.
Format: int64
available_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentWhen the subscription was created.
Format: date-time
end_datestringRequired within parentLast day the subscription is in force.
Format: date
idstringRequired within parentUnique identifier of the IT seat subscription.
Format: uuid
monthly_seat_priceModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price
Price of each seat per month.
paid_seatsJSONRequired within parent
paid_seats (anyOf 1)integerAlternativeNumber of seats the organization pays for.
Format: int64
paid_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_approval_seatsJSONRequired within parent
pending_approval_seats (anyOf 1)integerAlternativeNumber of seats pending purchase approval. These do not consume a paid seat until approved.
Format: int64
pending_approval_seats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_datestringRequired within parentFirst day the subscription is in force.
Format: date
statusstringRequired within parentCurrent status of the subscription.
Known values: ACTIVE, EXPIRED, TRIAL
termstringRequired within parentCommitted length of the subscription.
Known values: 12_MONTHS, 24_MONTHS, 36_MONTHS, CUSTOM

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price

Retrieve the IT seat subscription — 200 response body — data monthly seat price
FieldTypePresenceDescription and constraints
$objectRootPrice of each seat per month.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
FieldTypePresenceDescription and constraints
$stringRootThree-letter currency code for the price
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BDT, BGN, BHD, BIF, BMD, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWD

SDK function policy ID: deel.itseats_retrievetheitseatcontract_v2026_09_25. Catalog operation: itseats_retrievetheitseatcontract_v2026_09_25. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["it-seats:read"]

Pinned headers: {"X-Version": "2026-09-25"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.