Chargebee API Data ModelCatalog: Chargebee
Schema: Plans
Primary Keys: id
Label: Plans
Can retrieve data and change data using insert, update and delete.
Select Chargebee API URL: /plans
Insert Chargebee API URL: /plans
Update Chargebee API URL: /plans
Delete Chargebee API URL: /plans
Field Selection Method: NotRequired
Base Path: list[*].plan
Table Columns
The columns of the table Plans are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
accounting_category1 |
string |
Accounting Category 1 |
☐ |
|
accounting_category2 |
string |
Accounting Category 2 |
☐ |
|
accounting_code |
string |
Accounting Code |
☐ |
|
addon_applicability |
string |
Add-on Applicability |
☐ |
|
archived_at |
datetime |
Archived at |
☐ |
|
avalara_sale_type |
string |
Avalara Sale Type |
☐ |
|
avalara_service_type |
int32 |
Avalara Service Type |
☐ |
|
avalara_transaction_type |
int32 |
Avalara Transaction Type |
☐ |
|
billing_cycles |
int32 |
Billing Cycles |
☐ |
|
cf_visible_in_store |
boolean |
|
☐ |
|
claim_url |
string |
Claim URL |
☐ |
|
currency_code |
string |
Currency Code |
☐ |
|
description |
string |
Description |
☐ |
|
enabled_in_hosted_pages |
boolean |
Enabled in Hosted Pages |
☐ |
|
enabled_in_portal |
boolean |
Enabled in Portal |
☐ |
|
free_quantity |
int32 |
Free Quantity |
☐ |
|
free_quantity_in_decimal |
string |
Free Quantity in Decimal |
☐ |
|
giftable |
boolean |
Giftable |
☐ |
|
id |
string |
ID |
☑ |
|
invoice_name |
string |
Invoice Name |
☐ |
|
invoice_notes |
string |
Invoice Notes |
☐ |
|
is_shippable |
boolean |
Is Shippable |
☐ |
|
name |
string |
Name |
☐ |
|
period |
int32 |
Period |
☐ |
|
period_unit |
string |
Period Unit |
☐ |
|
price |
decimal |
Price |
☐ |
|
price_in_decimal |
string |
Price in Decimal |
☐ |
|
pricing_model |
string |
Pricing Model |
☐ |
|
redirect_url |
string |
Redirect URL |
☐ |
|
resource_version |
int64 |
Resource Version |
☐ |
|
setup_cost |
decimal |
Setup Cost |
☐ |
|
shipping_frequency_period |
int32 |
Shipping Frequency Period |
☐ |
|
shipping_frequency_period_unit |
string |
Shipping Frequency Period Unit |
☐ |
|
show_description_in_invoices |
boolean |
Show Description in Invoices |
☐ |
|
show_description_in_quotes |
boolean |
Show Description in Quotes |
☐ |
|
sku |
string |
SKU |
☐ |
|
status |
string |
Status |
☐ |
|
tax_code |
string |
Tax Code |
☐ |
|
tax_profile_id |
string |
Tax Profile ID |
☐ |
|
taxable |
boolean |
Taxable |
☐ |
|
taxjar_product_code |
string |
Taxjar Product Code |
☐ |
|
trial_period |
int32 |
Trial Period |
☐ |
|
trial_period_unit |
string |
Trial Period Unit |
☐ |
|
updated_at |
datetime |
Updated at |
☐ |
|
12-12-2020 18:45 Version 20.1.301-BETA+3023
