Get a specific item
GET/api/v3/item/:item_id
Get a specific item using its item_id.
Request
Responses
- 200
- 400
- 401
- 404
Object was fetched successfully
- application/json
- Schema
- Example (from schema)
- Example 1
- Example 2
Schema
code integer
status string
message stringnullable
details objectnullable
response object
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": {}
}
{
"code": 200,
"status": "OK",
"message": "",
"details": {},
"response": {
"item_id": 12,
"item_type": "service",
"tierset_id": 24,
"name": "My Test Service Plan",
"description": null,
"units": null,
"enabled": true,
"accounting_sku": null,
"external_key": null,
"token": "c162794b20v7",
"custom_1": null,
"custom_2": null,
"custom_3": null,
"write_datetime": "2019-10-07 11:15:51",
"mod_datetime": "2019-10-07 11:15:51",
"units_plural": "",
"expire_recurs": null,
"trial_recurs": null,
"service_data": {
"trial_days": 0,
"trial_units": 0,
"is_usage": false
},
"tiersets": [
{
"tierset_id": 24,
"currency_id": 1,
"setup": 0,
"base": 100,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2019-10-07 11:15:51",
"mod_datetime": "2019-10-07 11:15:51",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 100.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 24,
"currency_id": 1,
"setup": 0,
"base": 100,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2019-10-07 11:15:51",
"mod_datetime": "2019-10-07 11:15:51",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 100.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
}
],
"categories": []
}
}
{
"code": 200,
"status": "OK",
"message": "",
"details": {},
"response": {
"item_id": 665,
"item_type": "bundle",
"tierset_id": null,
"tax_group_id": null,
"name": "My Bundle Example",
"description": "",
"units": null,
"enabled": true,
"accounting_sku": null,
"accounting_account_income": null,
"external_key": null,
"token": "1jr4crjxtgnt",
"custom_1": "",
"custom_2": "",
"custom_3": null,
"write_datetime": "2024-05-06 15:06:02",
"mod_datetime": "2024-05-06 15:06:02",
"units_plural": "",
"tax_group_name": "",
"expire_recurs": null,
"trial_recurs": null,
"bundle_data": {
"components": [
{
"item_id": 434,
"item_type": "service",
"name": "My Test Product",
"description": "asdga",
"accounting_sku": null,
"external_key": null,
"token": "0okery6hq4ev",
"component_tiersets": [
{
"tierset_id": 1249,
"currency_id": 1,
"setup": 0,
"base": 234.56,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-12-18 10:21:02",
"mod_datetime": "2024-12-18 10:21:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 234.56",
"minimum_formatted": "$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 1250,
"currency_id": 2,
"setup": 0,
"base": 100,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-12-18 10:21:02",
"mod_datetime": "2024-12-18 10:21:02",
"currency_symbol": "CAD$",
"currency_iso4217": "CAD",
"setup_formatted": "CAD$ 0.00",
"base_formatted": "CAD$ 100.00",
"minimum_formatted": "CAD$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 1251,
"currency_id": 5,
"setup": 0,
"base": 1234,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "uni",
"write_datetime": "2024-12-18 10:21:02",
"mod_datetime": "2024-12-18 10:21:02",
"currency_symbol": "N$",
"currency_iso4217": "NZD",
"setup_formatted": "N$ 0.00",
"base_formatted": "N$ 1234.00",
"minimum_formatted": "N$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Unit Pricing (example: $X per unit every billing cycle)",
"tiers": [
{
"tier_id": 95,
"unit_from": 1,
"unit_to": 100,
"amount": 5,
"amount_per_paycycle": "$ 5.00/cycle"
},
{
"tier_id": 96,
"unit_from": 101,
"unit_to": 200,
"amount": 4,
"amount_per_paycycle": "$ 4.00/cycle"
}
]
},
{
"tierset_id": 1252,
"currency_id": 6,
"setup": 0,
"base": 235,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-12-18 10:21:02",
"mod_datetime": "2024-12-18 10:21:02",
"currency_symbol": "A$",
"currency_iso4217": "AUD",
"setup_formatted": "A$ 0.00",
"base_formatted": "A$ 235.00",
"minimum_formatted": "A$ 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": [
{
"tier_id": 97,
"unit_from": 1,
"unit_to": 100,
"amount": 5,
"amount_per_paycycle": "$ 5.00/cycle"
},
{
"tier_id": 98,
"unit_from": 101,
"unit_to": 200,
"amount": 4,
"amount_per_paycycle": "$ 4.00/cycle"
}
]
},
{
"tierset_id": 1253,
"currency_id": 7,
"setup": 0,
"base": 1234,
"minimum": 0,
"percent": 0,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-12-18 10:21:02",
"mod_datetime": "2024-12-18 10:21:02",
"currency_symbol": "د.ج",
"currency_iso4217": "DZD",
"setup_formatted": "د.ج 0.00",
"base_formatted": "د.ج 1234.00",
"minimum_formatted": "د.ج 0.00",
"percent_formatted": "0 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": [
{
"tier_id": 99,
"unit_from": 1,
"unit_to": 100,
"amount": 5,
"amount_per_paycycle": "$ 5.00/cycle"
},
{
"tier_id": 100,
"unit_from": 101,
"unit_to": 200,
"amount": 4,
"amount_per_paycycle": "$ 4.00/cycle"
}
]
}
]
},
{
"item_id": 2,
"item_type": "discount",
"name": "Discount",
"description": "Discount",
"accounting_sku": null,
"external_key": null,
"token": "xy2zpj5akho9",
"component_tiersets": [
{
"tierset_id": 849,
"currency_id": 1,
"setup": 0,
"base": 0,
"minimum": 0,
"percent": 5,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-04-29 15:38:02",
"mod_datetime": "2024-04-29 15:38:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 0.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "5 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 849,
"currency_id": 1,
"setup": 0,
"base": 0,
"minimum": 0,
"percent": 5,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-04-29 15:38:02",
"mod_datetime": "2024-04-29 15:38:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 0.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "5 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 849,
"currency_id": 1,
"setup": 0,
"base": 0,
"minimum": 0,
"percent": 5,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-04-29 15:38:02",
"mod_datetime": "2024-04-29 15:38:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 0.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "5 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 849,
"currency_id": 1,
"setup": 0,
"base": 0,
"minimum": 0,
"percent": 5,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-04-29 15:38:02",
"mod_datetime": "2024-04-29 15:38:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 0.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "5 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
},
{
"tierset_id": 849,
"currency_id": 1,
"setup": 0,
"base": 0,
"minimum": 0,
"percent": 5,
"paycycle": "evy",
"pricemodel": "fla",
"write_datetime": "2024-04-29 15:38:02",
"mod_datetime": "2024-04-29 15:38:02",
"currency_symbol": "$",
"currency_iso4217": "USD",
"setup_formatted": "$ 0.00",
"base_formatted": "$ 0.00",
"minimum_formatted": "$ 0.00",
"percent_formatted": "5 %",
"pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
"tiers": []
}
]
}
]
},
"tiersets": [],
"categories": []
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 400,
"status": "Error",
"message": "Missing or invalid parameter.",
"details": {},
"response": false
}
Authentication error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 401,
"status": "Error",
"message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
"details": {},
"response": false
}
Object not found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response booleannullable
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 404,
"status": "Error",
"message": "This object does not exist.",
"details": {},
"response": null
}
Loading...