invantive documentation
Invantive SupportforenAnmelden / Eintragen

ItemPrices: Chargebee Item Prices

read only REST

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

Es können nur Daten abgerufen werden.

API-Quelle

  • Endpunkt: /item_prices

Tabellenspalten

Die Spalten der Tabelle ItemPrices 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
accounting_detail_accounting_category1 varchar2(100) itgen_cbe_accounting_detail_accounting_category1
accounting_detail_accounting_category2 varchar2(100) itgen_cbe_accounting_detail_accounting_category2
accounting_detail_accounting_category3 varchar2(100) itgen_cbe_accounting_detail_accounting_category3
accounting_detail_accounting_category4 varchar2(100) itgen_cbe_accounting_detail_accounting_category4
accounting_detail_accounting_code varchar2(100) itgen_cbe_accounting_detail_accounting_code The identifier of the chart of accounts under which the item price falls in the accounting system.
accounting_detail_sku varchar2(100) itgen_cbe_accounting_detail_sku This maps to the sku or product name in the accounting integration.
archived_at datetime Archiviert am Timestamp indicating when this item was archived.
billing_cycles int32 Abrechnungszyklen The default number of billing cycles a subscription to the plan must run.Can be overridden for a subscription.
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.
created_at datetime Erstellt bei
currency_code varchar2(3) Währungscode The currency code (ISO 4217 format) for the item price.If subscriptions, invoices or differential prices exist for this item price, currency_code cannot be changed.
description varchar2(500) Description Description of the item price.
external_name varchar2(100) itgen_cbe_external_name The name of the item price used in customer-facing pages and documents.These include invoices and hosted pages.If not provided, then name is used
free_quantity int32 Kostenlose Menge Free quantity the subscriptions of this item_price will have.Only the quantity more than this will be charged for the subscription.
free_quantity_in_decimal decimal Freie Menge in Dezimalzahlen The quantity of the item that is available free-of-charge, represented in decimal.When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for.Applicable for quantity-based plans and only when multi-decimal pricing is enabled.
id varchar2(100) ID The identifier for the item price.It is unique and immutable.
invoice_notes varchar2(2000) Rechnungsnotizen A customer-facing note added to all invoices associated with this API resource.This note becomes one among all the notes displayed on the invoice PDF.
is_taxable char itgen_cbe_is_taxable Specifies whether taxes apply to this item price.This value is set and returned even if Taxes have been disabled in Chargebee.However, the value is effective only while Taxes are enabled.
item_family_id varchar2(100) itgen_cbe_item_family_id The id of the Item family that the item price belongs to.
item_id varchar2(100) itgen_cbe_item_id The id of the Item that the item price belongs to.
item_type varchar2(30) itgen_cbe_item_type Type of item.Possible values are: plan, addon or charge.
metadata varchar2 itgen_cbe_metadata A collection of key-value pairs that provides extra information about the item.
name varchar2(100) Name A unique display name for the item price in the Chargebee UI.If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
period int32 Period When the item type is plan: The billing period of the plan in period_units.For example, create a 6 month plan by providing period as 6 and period_unit as month.When item type is addon: The period of the addon in period_units.For example, create an addon with a 2 month period by providing period as 2 and period_unit as month.The period of an addon is the duration for which its price applies.When attached to a plan, the addon is billed for the billing period of the plan.Learn more.If subscriptions or invoices exist for this item price, period cannot be changed.The period is mandatory when the item type is plan or addon.
period_unit varchar2(30) Periodeneinheit The unit of time for period.If subscriptions or invoices exist for this item price, period_unit cannot be changed.The period_unit is mandatory when the item type is plan or addon.Possible values are: day, week, month or year.
price_in_decimal decimal Preis in Dezimalform The price of the item when the pricing_model is flat_fee.When the pricing model is per_unit, it is the price per unit quantity of the item.Not applicable for the other pricing models.The value is in decimal and in major units of the currency.Also, this is only applicable when multi-decimal pricing is enabled.
price_variant_id varchar2(100) itgen_cbe_price_variant_id An immutable unique identifier of a price variant.
pricing_model varchar2(30) Preismodell The pricing scheme for this item price.If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.Possible values are: flat_fee, per_unit, tiered, volume or stairstep.
proration_type varchar2(30) itgen_cbe_proration_type Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update.Possible values are: site_default, partial_term or full_term.
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.
shipping_period int32 itgen_cbe_shipping_period Defines the shipping frequency.
shipping_period_unit varchar2(30) itgen_cbe_shipping_period_unit Defines the shipping frequency in association with shipping period.Possible values are: day, week, month or year.
show_description_in_invoices char Beschreibung in Rechnungen anzeigen Whether the item price's description should be shown on invoice PDFs.If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes char Beschreibung in Anführungszeichen anzeigen Whether the item price's description should be shown on quote PDFs.If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
status varchar2 Status The status of the item price.Possible values: active, archived or deleted.
tax_detail_avalara_sale_type varchar2(30) itgen_cbe_tax_detail_avalara_sale_type Indicates the Avalara sale type for the item price.Applicable only if you use the AvaTax for Communications integration.Possible values are: wholesale, retail, consumed or vendor_use.
tax_detail_avalara_service_type int32 itgen_cbe_tax_detail_avalara_service_type Indicates the Avalara service type for the item price.Applicable only if you use the AvaTax for Communications integration.
tax_detail_avalara_tax_code varchar2(50) itgen_cbe_tax_detail_avalara_tax_code The Avalara tax codes for the item price.Applicable only if you use AvaTax for Sales integration.
tax_detail_avalara_transaction_type int32 itgen_cbe_tax_detail_avalara_transaction_type Indicates the Avalara transaction type for the item price.Applicable only if you use the AvaTax for Communications integration.
tax_detail_hsn_code varchar2(50) itgen_cbe_tax_detail_hsn_code The HSN code to which the item is mapped for calculating the customer’s tax in India.
tax_detail_tax_profile_id varchar2(50) itgen_cbe_tax_detail_tax_profile_id The tax profile of the item price.
tax_detail_taxjar_product_code varchar2(50) itgen_cbe_tax_detail_taxjar_product_code The TaxJar product code for the item price.Applicable only if you use TaxJar integration.
trial_end_action varchar2(30) itgen_cbe_trial_end_action Applicable only when End-of-trial Action has been enabled for the site.Specifies the operation to be carried out for the subscription once the trial ends.Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required).This can be overridden at the subscription-level.Possible values are: site_default, activate_subscription or cancel_subscription.
trial_period int32 Testphase The trial period of the plan in trial_period_units.You can also set trial periods for addons; contact Support to enable that feature.
trial_period_unit varchar2(30) Testphase-Einheit The unit of time for trial_period.Possible values are: day or month.
updated_at datetime Aktualisiert am

Anmerkungen zu dieser Version

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