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

item_id integer

Item ID #

item_type string

Item type

name string

Item name

description string

Description

enabled boolean

Enabled/disabled

accounting_sku string

Accounting SKU

accounting_account_income string

Accounting Income Account

external_key string

External key value

units string

Units string

units_plural string

Units string pluralized

tax_group_id integer

Tax group ID #

tax_group_name string

Tax group name

expire_recurs integer

Default number of times to recur

trial_recurs integer

Default number of times to skip/free trial cycles

service_dates_type string

Service date type

Possible values: [none, starts_on_invoice_date, starts_on_first_of_this_month, starts_on_first_of_next_month, ends_before_invoice_date]

service_dates_visibility string

Service dates visibility

Possible values: [visible_to_merchant, visible_to_merchant_and_customers]

revrec_method string

Revenue recognition method

Possible values: [none, ratable_daily, ratable_30_360, installment, sales_basis, completed_contract]

token string

Unique token

tierset_id integer

Default pricing tierset ID #

write_datetime string

Date/time the item was created

mod_datetime string

Date/time the item was last updated

custom_1 string

Custom field value #1

custom_2 string

Custom field value #2

custom_3 string

Custom field value #3

custom_4 string

Custom field value #4

custom_5 string

Custom field value #5

custom_6 string

Custom field value #6

custom_7 string

Custom field value #7

custom_8 string

Custom field value #8

custom_9 string

Custom field value #9

custom_10 string

Custom field value #10

custom_11 string

Custom field value #11

custom_12 string

Custom field value #12

custom_13 string

Custom field value #13

custom_14 string

Custom field value #14

custom_15 string

Custom field value #15

custom_16 string

Custom field value #16

custom_17 string

Custom field value #17

custom_18 string

Custom field value #18

custom_19 string

Custom field value #19

custom_20 string

Custom field value #20

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "item_id": 0,
    "item_type": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "accounting_sku": "string",
    "accounting_account_income": "string",
    "external_key": "string",
    "units": "string",
    "units_plural": "string",
    "tax_group_id": 0,
    "tax_group_name": "string",
    "expire_recurs": 0,
    "trial_recurs": 0,
    "service_dates_type": "none",
    "service_dates_visibility": "visible_to_merchant",
    "revrec_method": "none",
    "token": "string",
    "tierset_id": 0,
    "write_datetime": "string",
    "mod_datetime": "string",
    "custom_1": "string",
    "custom_2": "string",
    "custom_3": "string",
    "custom_4": "string",
    "custom_5": "string",
    "custom_6": "string",
    "custom_7": "string",
    "custom_8": "string",
    "custom_9": "string",
    "custom_10": "string",
    "custom_11": "string",
    "custom_12": "string",
    "custom_13": "string",
    "custom_14": "string",
    "custom_15": "string",
    "custom_16": "string",
    "custom_17": "string",
    "custom_18": "string",
    "custom_19": "string",
    "custom_20": "string"
  }
}

Example 1

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

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...