Deel: Retrieve a product's prices for a delivery country
Deel itProducts.retrieveItProductPrices: arguments, response, policy and SDK examples.
← IT products operations · Get started
Operation deel.itproducts_retrieveitproductprices_v2026_10_28
Provider route: GET /it/products/{product_id}/prices/{country_code}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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["itProducts"]["retrieveItProductPrices"]>[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.itProducts.retrieveItProductPrices(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_products.retrieve_it_product_prices(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.product_id | string | Required within parent | Format: uuid |
path.country_code | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.variant_ids | array | Optional | |
query.variant_ids[] | string | Each item | Format: uuid |
query.acquisition_types | array | Optional | |
query.acquisition_types[] | string | Each item | One of: PURCHASE, RENTAL, REUSE |
query.rental_terms | array | Optional | |
query.rental_terms[] | string | Each item | One of: MONTH_12, MONTH_24 |
query.payment_schemas | array | Optional | |
query.payment_schemas[] | string | Each item | One of: MONTHLY, UPFRONT |
query.extend | array | Optional | |
query.extend[] | string | Each item | One of: AVAILABLE_ADDONS |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve a product’s prices for a delivery country — 200 response body |
Referenced models: Retrieve a product’s prices for a delivery country — 200 response body
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Retrieve a product's prices for a delivery country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data |
Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data
Retrieve a product's prices for a delivery country — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data country ISO 3166 alpha-2 code of the delivery country the prices apply to |
prices | array | Required within parent | One price per variant and contract setting the organization can order for delivery to the country. Rows are grouped by variant, cheapest variant first (by its lowest total_price), then by SKU. A variant that cannot be priced for the country is left out. |
prices[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item |
product_id | string | Required within parent | Unique identifier of the product Format: uuid |
Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data country, Retrieve a product's prices for a delivery country — 200 response body — data prices item
Retrieve a product's prices for a delivery country — 200 response body — data country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | ISO 3166 alpha-2 code of the delivery country the prices apply to Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW |
Retrieve a product's prices for a delivery country — 200 response body — data prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
asset_price | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price Equipment price over the whole contract, storefront fee excluded |
available_addons | JSON | Required within parent | |
available_addons (anyOf 1) | array | Alternative | Service and warranty addons this price can be ordered with, and what each costs on top of it. Null unless the request has `extend=AVAILABLE_ADDONS`. |
available_addons (anyOf 1)[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item |
available_addons (anyOf 2) | null | Alternative | Service and warranty addons this price can be ordered with, and what each costs on top of it. Null unless the request has `extend=AVAILABLE_ADDONS`. |
available_addons (anyOf 2)[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item |
contract_setting | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item contract setting Contract setting this price applies to. Submit it as `contract_setting` on `POST /rest/it/orders` to order at this price, leaving out null fields and adding `addons`, empty for none. |
payments_count | JSON | Required within parent | |
payments_count (anyOf 1) | integer | Alternative | Number of payments over the contract. 1 for purchases and upfront rentals. Format: int64 |
payments_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_per_payment | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment Amount charged per payment, storefront fee included. Addons are priced separately in available_addons. |
sku | JSON | Required within parent | |
sku (anyOf 1) | string | Alternative | SKU of the variant |
sku (anyOf 2) | null | Alternative | SKU of the variant |
storefront_fee | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee Storefront fee over the whole contract |
total_price | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item total price Total over the whole contract: asset_price plus storefront_fee. Addons are priced separately in available_addons. |
variant_id | string | Required within parent | Unique identifier of the variant this price is for. Submit it as `variant_id` on `POST /rest/it/orders`. Format: uuid |
Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price, Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item, Retrieve a product's prices for a delivery country — 200 response body — data prices item contract setting, Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment, Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee, Retrieve a product's prices for a delivery country — 200 response body — data prices item total price
Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Equipment price over the whole contract, storefront fee excluded |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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 a product's prices for a delivery country — 200 response body — data prices item contract setting
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract setting this price applies to. Submit it as `contract_setting` on `POST /rest/it/orders` to order at this price, leaving out null fields and adding `addons`, empty for none. |
acquisition_type | string | Required within parent | How the equipment is acquired Known values: PURCHASE, RENTAL, REUSE |
payment_schema | JSON | Required within parent | How the rental is billed. Null for purchases, which are paid upfront. |
payment_schema (anyOf 1) | string | Alternative | How the rental is billed. Null for purchases, which are paid upfront. Known values: MONTHLY, UPFRONT |
payment_schema (anyOf 2) | null | Alternative | |
rental_term | JSON | Required within parent | Rental term length. Null for purchases. |
rental_term (anyOf 1) | string | Alternative | Rental term length. Null for purchases. Known values: MONTH_12, MONTH_24 |
rental_term (anyOf 2) | null | Alternative |
Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amount charged per payment, storefront fee included. Addons are priced separately in available_addons. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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 a product's prices for a delivery country — 200 response body — data prices item storefront fee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Storefront fee over the whole contract |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itproducts_retrieveitproductprices_v2026_10_28. Catalog operation: itproducts_retrieveitproductprices_v2026_10_28. 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-products:read"]
Pinned headers: {"X-Version": "2026-10-28"}