Create Item

post

https://{subdomain}.{domain}/v2/items

Create a new item in the catalog.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

item_code

string

required

Unique code to identify the item. Max of 50 characters.

name

string

required

Item name. Max of 255 characters.

description

string

Optional plan description, not displayed.

external_sku

string

Stock keeping unit to link the item to other inventory. Max of 50 characters.

accounting_code

string

Accounting code for invoice line items. Code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters.

revenue_schedule_type

string

Defaults to evenly

Optional field for setting a revenue schedule type. This will determine how revenue for the associated Item should be recognized. Available schedule types are never, evenly, at_range_start, or at_range_end.

state

string

The current state of the item. Will be either active or inactive. Read-only.

custom_fields

array of objects

The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Custom Fields

liability_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

revenue_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

performance_obligation_id

string

length ≤ 13

The ID of a performance obligation. Performance obligations are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

Response

201