Please enable JavaScript to view this site.

Chargebee API Data Model

Navigation: Schema: Addresses > Tables

Addresses: Chargebee Addresses

Contents Previous Home Next More

Catalog: Chargebee

Schema: Addresses

Label: Addresses

This is a read-only table function. The Chargebee API may not support changing the data or the Invantive SQL driver for Chargebee does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Chargebee API.

Select Chargebee API URL: /addresses

Insert Chargebee API URL: /addresses

Update Chargebee API URL: /addresses

Delete Chargebee API URL: /addresses

Field Selection Method: NotRequired

Base Path: address

Table Function Parameters

The following parameters can be used to control the behaviour of the table function Addresses. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

label

string

☑

 

 

subscription_id

string

☑

 

 

 

Table Function Columns

The columns of the table function Addresses are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

addr

string

Address

☐

 

city

string

City

☐

 

company

string

Company

☐

 

country

string

Country

☐

 

email

string

Email

☐

 

extended_addr

string

Extended Address

☐

 

extended_addr2

string

Extended Address 2

☐

 

first_name

string

First Name

☐

 

label

string

Label

☑

 

last_name

string

Last Name

☐

 

phone

string

Phone

☐

 

state

string

State

☐

 

state_code

string

State Code

☐

 

subscription_id

string

Subscription ID

☐

 

validation_status

string

Validation Status

☐

 

zip

string

ZIP Code

☐

 

 

12-12-2020 18:45 Version 20.1.301-BETA+3023