invantive documentation
Invantive SupportforenAnmelden / Eintragen

Items: Chargebee Items

read only REST

  • Katalog: Chargebee
  • Schema: Items
  • Primärschlüssel: id
  • Label: Items

Es können nur Daten abgerufen werden.

API-Quelle

  • Endpunkt: /items

Tabellenspalten

Die Spalten der Tabelle Items sind unten aufgeführt. Jede Spalte hat einen SQL-Datentyp. Beim Einfügen und Aktualisieren muss für jede erforderliche Spalte jederzeit ein neuer Wert angegeben werden der nicht Null ist.

Name Datentyp Label Required Marks Documentation
archived_at datetime Archiviert am Timestamp indicating when this item was archived.
channel varchar2(30) itgen_cbe_channel The subscription channel this object originated from and is maintained in.Possible values are: web, app_store or play_store.
description varchar2(500) Description Description of the item.This is visible only in Chargebee and not to customers.
enabled_for_checkout char itgen_cbe_enabled_for_checkout Allow the plan to subscribed to via Checkout.Applies only for plan-items.Note: Only the in-app version of Checkout is supported for Product Catalog v2.
enabled_in_portal char Im Portal aktiviert Allow customers to change their subscription to this plan via the Self-Serve Portal.Applies only for plan-items.This requires the Portal configuration to allow changing subscriptions.
external_name varchar2(100) itgen_cbe_external_name A unique display name for the item.
gift_claim_redirect_url varchar2(500) itgen_cbe_gift_claim_redirect_url The URL to redirect to once the gift has been claimed by the receiver.
id varchar2(100) ID The identifier for the item.It is unique and immutable.
included_in_mrr char Im MRR enthalten The item is included in MRR calculations for your site.This attribute is only applicable for items of type = charge and when the feature is enabled in Chargebee.Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false.
is_giftable char itgen_cbe_is_giftable Specifies if gift subscriptions can be created for this item.
is_shippable char Ist versandfähig Indicates that the item is a physical product.If Orders are enabled in Chargebee, subscriptions created for this item will have orders associated with them.
item_applicability varchar2(30) itgen_cbe_item_applicability Indicates which addon-items and charge-items can be applied to the item.Only meant for plan-items.Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create or Update an attached item API.Possible values: all or restricted.
item_family_id varchar2(100) itgen_cbe_item_family_id The id of the Item family that the item belongs to.Is mandatory when Product Families have been enabled.
metadata varchar2 itgen_cbe_metadata A collection of key-value pairs that provides extra information about the item.
metered char itgen_cbe_metered Specifies whether the item undergoes metered billing.When true, the quantity is calculated from usage records.When false, the quantity is as determined while adding an item price to the subscription.Applicable only for items of type plan or addon and when Metered Billing is enabled.The value of this attribute cannot be changed.
name varchar2(100) Name A unique display name for the item.This is visible only in Chargebee and not to customers.
redirect_url varchar2(500) Weiterleitungs-URL If enabled_for_checkout, then the URL to be redirected to once the checkout is complete.This attribute is only available for plan-items.
resource_version int64 Ressourcenversion The version number of this resource.For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.
status varchar2 Status The status of the item.Possible values: active, archived or deleted.
type varchar2(30) Type The type of the item.Possible values: plan, addon or charge.
unit varchar2(30) Unit The unit of measure for a quantity-based item.This is displayed on the Chargebee UI and on customer facing documents/pages.The latter includes hosted pages, invoices and quotes.
updated_at datetime Aktualisiert am
usage_calculation varchar2(30) itgen_cbe_usage_calculation How the quantity is calculated from usage data for the item prices belonging to this item.Only applicable when the item is metered.This value overrides the one set at the site level.Possible values are: sum_of_usages, last_usage or max_usage.

Anmerkungen zu dieser Version

Was hat sich in den Tabellen, Spalten, Attributen und Funktionen des Treibers mit jeder neuen Version geändert: