Create an item

POST 
/api/v3/item

The response/id value will be the item_id value for the newly created item.

Valid values for paycycle

• evy - Every billing cycle
• dly - Daily
• 1wk - Every week
• 2wk - Every other week
• 116 - 1st and the 16th
• 4wk - Every four weeks
• 8wk - Every eight weeks
• 30d - Every 30 days
• mon - Monthly
• 2mn - Every other month
• 12w - Every twelve weeks
• qtr - Quarterly
• six - Every six months
• yrl - Yearly
• 2yr - Every 2 years
• 3yr - Every 3 years
• 4yr - Every 4 years
• 5yr - Every 5 years
• 10y - Every 10 years

Valid values for pricemodel

• fla - Flat Pricing (example: $X dollars every billing cycle)
• uni - Unit Pricing (example: $X per unit every billing cycle)
• vol - Volume Pricing (example: $X dollars every billing cycle, with different price levels depending on volume)
• tie - Tiered Pricing (example: $X dollars every billing cycle for the first 10 units, then $Y dollars per month for the next 10 units, etc.)
• pas - Pass-through from usage data (Pass-through pricing is for scenarios where the usage data and the pricing is already known)

Request

application/json

Body

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

tax_group_id integer

Tax group ID #

expire_recurs integer

Default number of times to recur

trial_recurs integer

Default number of times to skip/free trial cycles

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

Responses

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

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

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

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
}

Loading...