Skip to main content

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​

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 # of times to recur

    trial_recurs integer

    Default # 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

Responses​

Object was created successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object

    id integer
Loading...