The One Time Item object v2

Billing
One Time Items
The One Time Item object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.billing.one_time_item"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • createdtimestamp

    Timestamp of when the object was created.

  • display_namestring

    Description that customers will see in the invoice line item. Maximum length of 250 characters.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • lookup_keynullable string

    An internal key you can use to search for a particular one-time item. Maximum length of 200 characters.

  • metadatanullable map

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • unit_labelnullable string

    The unit to use when displaying prices for this one-time item. For example, set this field to “credit” for the display to show “(price) per credit”. Maximum length of 100 characters.

The One Time Item object
{
"created": "2025-01-01T00:00:00.000Z",
"display_name": "Setup Fee",
"id": "bli_test_61SGRtYMvrf176Kmm16RM8VQESSQ4t1K5KYFAmKUSOTI",
"lookup_key": "setup-fee",
"metadata": {
"category": "onboarding"
},
"object": "v2.billing.one_time_item",
"unit_label": "per account",
"livemode": true
}