Get a specific item

GET 
/api/v3/item/:item_id

Get a specific item using its item_id.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "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": []
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...