Subscriptions: Chargebee Subscriptions
insert update delete REST
- Catalog:
Chargebee - Schema:
Subscriptions - Primary Keys:
id - Label: Subscriptions
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/subscriptions
Table Columns
The columns of the table Subscriptions 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 and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
activated_ |
datetime |
Activated at | |||
active_ |
varchar2 |
itgen_cbe_active_id | Represents the id of the active version of the customer resource. | ||
affiliate_ |
varchar2 |
Affiliate Token | |||
auto_ |
char |
itgen_cbe_auto_close_invoices | |||
auto_ |
varchar2 |
Auto Collection | |||
base_ |
varchar2 |
Base Currency Code | |||
billing_ |
int16 |
Billing Period | |||
billing_ |
varchar2 |
Billing Period Unit | |||
business_ |
varchar2 |
itgen_cbe_business_entity_id | |||
cancel_ |
varchar2 |
Cancel Reason | |||
cancel_ |
varchar2 |
Cancel Reason Code | |||
cancel_ |
datetime |
itgen_cbe_cancel_schedule_created_at | |||
cancelled_ |
datetime |
Cancelled at | |||
changes_ |
datetime |
itgen_cbe_changes_scheduled_at | |||
channel |
varchar2 |
itgen_cbe_channel | The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store. | ||
contract_ |
varchar2 |
Contract Term Action at Term End | |||
contract_ |
int32 |
Contract Term Billing Cycle | |||
contract_ |
int32 |
Contract Term Billing Cycle on Renewal | |||
contract_ |
int32 |
Contract Term Cancellation Cut-off Period | |||
contract_ |
datetime |
Contract Term Contract End | |||
contract_ |
datetime |
Contract Term Contract Start | |||
contract_ |
datetime |
Contract Term Created at | |||
contract_ |
varchar2 |
Contract Term ID | |||
contract_ |
int32 |
Contract Term Remaining Billing Cycles | |||
contract_ |
varchar2 |
Contract Term Status | |||
contract_ |
varchar2 |
Contract Term Subscription ID | |||
contract_ |
decimal |
Contract Term Total Contract Value | |||
contract_ |
decimal |
itgen_cbe_contract_term_total_contract_value_before_tax | |||
create_ |
char |
itgen_cbe_create_pending_invoices | |||
created_ |
datetime |
Created at | |||
created_ |
varchar2 |
Created From IP | |||
currency_ |
varchar2 |
Currency Code | |||
current_ |
datetime |
Current Term End | |||
current_ |
datetime |
Current Term Start | |||
customer_ |
varchar2 |
Customer ID | |||
deleted |
char |
Deleted | |||
due_ |
int32 |
Due Invoices Count | |||
due_ |
datetime |
Due Since | |||
exchange_ |
decimal |
Exchange Rate | |||
free_ |
int32 |
Free Period | |||
free_ |
varchar2 |
Free Period Unit | |||
gift_ |
varchar2 |
Gift ID | |||
has_ |
char |
itgen_cbe_has_scheduled_advance_invoices | |||
has_ |
char |
Has Scheduled Changes | |||
id |
varchar2 |
ID | |||
invoice_ |
varchar2 |
Invoice Notes | |||
meta_ |
varchar2 |
Meta Data | |||
mrr |
int32 |
MRR | |||
net_ |
int32 |
Net Term Days | |||
next_ |
datetime |
Next Billing at | |||
offline_ |
varchar2 |
Offline Payment Method | |||
override_ |
char |
Override Relationship | |||
pause_ |
datetime |
Pause Date | |||
payment_ |
varchar2 |
Payment Source ID | |||
plan_ |
decimal |
Plan Amount | |||
plan_ |
varchar2 |
Plan Amount in Decimal | |||
plan_ |
int32 |
Plan Free Quantity | |||
plan_ |
varchar2 |
Plan Free Quantity in Decimal | |||
plan_ |
varchar2 |
Plan ID | |||
plan_ |
int32 |
Plan Quantity | |||
plan_ |
varchar2 |
Plan Quantity in Decimal | |||
plan_ |
decimal |
Plan Unit Price | |||
plan_ |
varchar2 |
Plan Unit Price in Decimal | |||
po_ |
varchar2 |
PO Number | |||
referral_ |
varchar2 |
Referral Info Account ID | |||
referral_ |
varchar2 |
Referral Info Campaign ID | |||
referral_ |
varchar2 |
Referral Info Coupon Code | |||
referral_ |
varchar2 |
Referral Info Destination URL | |||
referral_ |
varchar2 |
Referral Info External Campaign ID | |||
referral_ |
varchar2 |
Referral Info External Reference ID | |||
referral_ |
varchar2 |
Referral Info Friend Offer Type | |||
referral_ |
varchar2 |
Referral Info Notify Referral System | |||
referral_ |
char |
Referral Info Post Purchase Widget Enabled | |||
referral_ |
varchar2 |
Referral Info Referral Code | |||
referral_ |
varchar2 |
Referral Info Referral System | |||
referral_ |
varchar2 |
Referral Info Referrer ID | |||
referral_ |
varchar2 |
Referral Info Referrer Reward Type | |||
referral_ |
varchar2 |
Referral Info Reward Status | |||
remaining_ |
int32 |
Remaining Billing Cycles | |||
resource_ |
int64 |
Resource Version | |||
resume_ |
datetime |
Resume Date | |||
setup_ |
decimal |
Setup Fee | |||
shipping_ |
varchar2 |
Shipping Address City | |||
shipping_ |
varchar2 |
Shipping Address Company | |||
shipping_ |
varchar2 |
Shipping Address Country | |||
shipping_ |
varchar2 |
Shipping Address Email | |||
shipping_ |
varchar2 |
Shipping Address First Name | |||
shipping_ |
varchar2 |
Shipping Address Last Name | |||
shipping_ |
varchar2 |
Shipping Address Line 1 | |||
shipping_ |
varchar2 |
Shipping Address Line 2 | |||
shipping_ |
varchar2 |
Shipping Address Phone | |||
shipping_ |
varchar2 |
Shipping Address State | |||
shipping_ |
varchar2 |
itgen_cbe_shipping_address_state_code | |||
shipping_ |
varchar2 |
Shipping Address Validation Status | |||
shipping_ |
varchar2 |
Shipping Address ZIP Code | |||
start_ |
datetime |
Start Date | |||
started_ |
datetime |
Started at | |||
status |
varchar2 |
Status | |||
total_ |
int32 |
Total Dues | |||
trial_ |
datetime |
Trial End | |||
trial_ |
varchar2 |
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_ |
datetime |
Trial Start | |||
updated_ |
datetime |
Updated at |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: