Subscriptions

The Subscriptions module provides access to contextual information about the current subscription when a widget is rendered within supported subscription-related pages. Widgets can retrieve subscription identifiers, plan details, and lifecycle-related metadata for use in validations, conditional logic, and UI extensions.

Methods

Methods

Get Subscriptions Details

Retrieves data related to the current context. This method allows your widget to fetch record details, field values, or metadata required for rendering or processing logic.

Commonly used for :

• Fetch record information
• Read field values
• Access contextual module data

Supported Locations :

subscriptions.bulkaction.buttonsubscriptions.creation.sidebarsubscriptions.details.sidebarsubscriptions.details.button

Sample Code :

REQUEST DETAILS

window.onload = function () {
  ZFAPPS.extension.init().then(function(App) {
    ZFAPPS.get('subscriptions').then(function (data) {
     //response Handling
    }).catch(function (err) {
     //error Handling
    });
  });
}

Supported Input Keys :

Property	Request
subscription_id	subscriptions.subscription_id
name	subscriptions.name
crm_owner_id	subscriptions.crm_owner_id
zcrm_potential_id	subscriptions.zcrm_potential_id
zcrm_potential_name	subscriptions.zcrm_potential_name
subscription_number	subscriptions.subscription_number
is_metered_billing	subscriptions.is_metered_billing
status	subscriptions.status
status_formatted	subscriptions.status_formatted
sub_total	subscriptions.sub_total

Show More Supported Input Keys

Property	Request
sub_total_formatted	subscriptions.sub_total_formatted
amount	subscriptions.amount
amount_formatted	subscriptions.amount_formatted
created_at	subscriptions.created_at
created_at_formatted	subscriptions.created_at_formatted
activated_at	subscriptions.activated_at
activated_at_formatted	subscriptions.activated_at_formatted
current_term_starts_at	subscriptions.current_term_starts_at
current_term_starts_at_formatted	subscriptions.current_term_starts_at_formatted
current_term_ends_at	subscriptions.current_term_ends_at
current_term_ends_at_formatted	subscriptions.current_term_ends_at_formatted
last_billing_at	subscriptions.last_billing_at
last_billing_at_formatted	subscriptions.last_billing_at_formatted
next_billing_at	subscriptions.next_billing_at
next_billing_at_formatted	subscriptions.next_billing_at_formatted
expires_at	subscriptions.expires_at
expires_at_formatted	subscriptions.expires_at_formatted
interval	subscriptions.interval
interval_unit	subscriptions.interval_unit
interval_unit_formatted	subscriptions.interval_unit_formatted
shipping_interval	subscriptions.shipping_interval
shipping_interval_unit	subscriptions.shipping_interval_unit
billing_mode	subscriptions.billing_mode
next_shipment_at	subscriptions.next_shipment_at
next_shipment_at_formatted	subscriptions.next_shipment_at_formatted
next_shipment_day	subscriptions.next_shipment_day
total_orders	subscriptions.total_orders
orders_created	subscriptions.orders_created
orders_remaining	subscriptions.orders_remaining
last_shipment_at	subscriptions.last_shipment_at
last_shipment_at_formatted	subscriptions.last_shipment_at_formatted
last_shipment_day	subscriptions.last_shipment_day
auto_collect	subscriptions.auto_collect
created_time	subscriptions.created_time
updated_time	subscriptions.updated_time
reference_id	subscriptions.reference_id
salesperson_id	subscriptions.salesperson_id
salesperson_name	subscriptions.salesperson_name
child_invoice_id	subscriptions.child_invoice_id
currency_code	subscriptions.currency_code
currency_symbol	subscriptions.currency_symbol
coupon_duration	subscriptions.coupon_duration
scheduled_cancellation_date	subscriptions.scheduled_cancellation_date
scheduled_cancellation_date_formatted	subscriptions.scheduled_cancellation_date_formatted
is_item_subscriptions	subscriptions.is_item_subscriptions
trial_extended_count	subscriptions.trial_extended_count
end_of_term	subscriptions.end_of_term
remaining_billing_cycles	subscriptions.remaining_billing_cycles
product_id	subscriptions.product_id
product_name	subscriptions.product_name
pricebook_id	subscriptions.pricebook_id
items_associated	subscriptions.items_associated
channel_source	subscriptions.channel_source
channel_reference_id	subscriptions.channel_reference_id
can_prorate	subscriptions.can_prorate
can_invoice_prorated_amount	subscriptions.can_invoice_prorated_amount
line_items	subscriptions.line_items
plan	subscriptions.plan
addons	subscriptions.addons
pending_addons	subscriptions.pending_addons
taxes	subscriptions.taxes
discount_total	subscriptions.discount_total
discount_total_formatted	subscriptions.discount_total_formatted
discount_percent	subscriptions.discount_percent
discount	subscriptions.discount
discount_applied_on_amount	subscriptions.discount_applied_on_amount
discount_type	subscriptions.discount_type
is_discount_before_tax	subscriptions.is_discount_before_tax
bcy_discount_total	subscriptions.bcy_discount_total
exchange_rate	subscriptions.exchange_rate
exchange_rate_formatted	subscriptions.exchange_rate_formatted
is_inclusive_tax	subscriptions.is_inclusive_tax
tax_rounding	subscriptions.tax_rounding
roundoff_value	subscriptions.roundoff_value
roundoff_value_formatted	subscriptions.roundoff_value_formatted
transaction_rounding_type	subscriptions.transaction_rounding_type
payment_terms	subscriptions.payment_terms
payment_terms_label	subscriptions.payment_terms_label
template_id	subscriptions.template_id
can_add_bank_account	subscriptions.can_add_bank_account
created_by_id	subscriptions.created_by_id
last_modified_by_id	subscriptions.last_modified_by_id
created_date	subscriptions.created_date
created_date_formatted	subscriptions.created_date_formatted
start_date	subscriptions.start_date
start_date_formatted	subscriptions.start_date_formatted
customer_id	subscriptions.customer_id
customer	subscriptions.customer
invoice_notes	subscriptions.invoice_notes
custom_fields	subscriptions.custom_fields
custom_field_hash	subscriptions.custom_field_hash
reactivate_date	subscriptions.reactivate_date
reactivate_date_formatted	subscriptions.reactivate_date_formatted
contactpersons	subscriptions.contactpersons
contact_persons_associated	subscriptions.contact_persons_associated
notes	subscriptions.notes
allow_partial_payments	subscriptions.allow_partial_payments
auto_apply_credits	subscriptions.auto_apply_credits
payment_gateways	subscriptions.payment_gateways
is_advance_invoice_present	subscriptions.is_advance_invoice_present
end_of_term_scheduled_date	subscriptions.end_of_term_scheduled_date
end_of_term_scheduled_date_formatted	subscriptions.end_of_term_scheduled_date_formatted
apply_changes_on	subscriptions.apply_changes_on
apply_changes_on_formatted	subscriptions.apply_changes_on_formatted
is_scheduled_update	subscriptions.is_scheduled_update
price_change_mode	subscriptions.price_change_mode
void_open_invoices_on_cancellation	subscriptions.void_open_invoices_on_cancellation
allow_in_term_reactivation	subscriptions.allow_in_term_reactivation
last_child_inv_balance	subscriptions.last_child_inv_balance
last_child_inv_balance_formatted	subscriptions.last_child_inv_balance_formatted
last_child_inv_status	subscriptions.last_child_inv_status
is_in_term_reactivation_scheduled	subscriptions.is_in_term_reactivation_scheduled
max_date_for_in_term	subscriptions.max_date_for_in_term

Set Subscriptions Details

Updates or sets data within the current context. This method allows your widget to modify field values, update state, or pass data back to the host application.

Commonly used for :

• Update field values
• Set widget or module state
• Pass data to the parent application

Supported Locations :

subscriptions.creation.sidebar

Sample Code :

REQUEST DETAILS

window.onload = function () {
  ZFAPPS.extension.init().then(function(App) {
    ZFAPPS.set('subscriptions.name', <value>).then(function (data) {
     //response Handling
    }).catch(function (err) {
     //error Handling
    });
  });
}

Supported Input Keys :

Property	Request
subscription_id	subscriptions.subscription_id
name	subscriptions.name
crm_owner_id	subscriptions.crm_owner_id
zcrm_potential_id	subscriptions.zcrm_potential_id
zcrm_potential_name	subscriptions.zcrm_potential_name
subscription_number	subscriptions.subscription_number
is_metered_billing	subscriptions.is_metered_billing
status	subscriptions.status
status_formatted	subscriptions.status_formatted
sub_total	subscriptions.sub_total

Show More Supported Input Keys

Property	Request
sub_total_formatted	subscriptions.sub_total_formatted
amount	subscriptions.amount
amount_formatted	subscriptions.amount_formatted
created_at	subscriptions.created_at
created_at_formatted	subscriptions.created_at_formatted
activated_at	subscriptions.activated_at
activated_at_formatted	subscriptions.activated_at_formatted
current_term_starts_at	subscriptions.current_term_starts_at
current_term_starts_at_formatted	subscriptions.current_term_starts_at_formatted
current_term_ends_at	subscriptions.current_term_ends_at
current_term_ends_at_formatted	subscriptions.current_term_ends_at_formatted
last_billing_at	subscriptions.last_billing_at
last_billing_at_formatted	subscriptions.last_billing_at_formatted
next_billing_at	subscriptions.next_billing_at
next_billing_at_formatted	subscriptions.next_billing_at_formatted
expires_at	subscriptions.expires_at
expires_at_formatted	subscriptions.expires_at_formatted
interval	subscriptions.interval
interval_unit	subscriptions.interval_unit
interval_unit_formatted	subscriptions.interval_unit_formatted
shipping_interval	subscriptions.shipping_interval
shipping_interval_unit	subscriptions.shipping_interval_unit
billing_mode	subscriptions.billing_mode
next_shipment_at	subscriptions.next_shipment_at
next_shipment_at_formatted	subscriptions.next_shipment_at_formatted
next_shipment_day	subscriptions.next_shipment_day
total_orders	subscriptions.total_orders
orders_created	subscriptions.orders_created
orders_remaining	subscriptions.orders_remaining
last_shipment_at	subscriptions.last_shipment_at
last_shipment_at_formatted	subscriptions.last_shipment_at_formatted
last_shipment_day	subscriptions.last_shipment_day
auto_collect	subscriptions.auto_collect
created_time	subscriptions.created_time
updated_time	subscriptions.updated_time
reference_id	subscriptions.reference_id
salesperson_id	subscriptions.salesperson_id
salesperson_name	subscriptions.salesperson_name
child_invoice_id	subscriptions.child_invoice_id
currency_code	subscriptions.currency_code
currency_symbol	subscriptions.currency_symbol
coupon_duration	subscriptions.coupon_duration
scheduled_cancellation_date	subscriptions.scheduled_cancellation_date
scheduled_cancellation_date_formatted	subscriptions.scheduled_cancellation_date_formatted
is_item_subscriptions	subscriptions.is_item_subscriptions
trial_extended_count	subscriptions.trial_extended_count
end_of_term	subscriptions.end_of_term
remaining_billing_cycles	subscriptions.remaining_billing_cycles
product_id	subscriptions.product_id
product_name	subscriptions.product_name
pricebook_id	subscriptions.pricebook_id
items_associated	subscriptions.items_associated
channel_source	subscriptions.channel_source
channel_reference_id	subscriptions.channel_reference_id
can_prorate	subscriptions.can_prorate
can_invoice_prorated_amount	subscriptions.can_invoice_prorated_amount
line_items	subscriptions.line_items
plan	subscriptions.plan
addons	subscriptions.addons
pending_addons	subscriptions.pending_addons
taxes	subscriptions.taxes
discount_total	subscriptions.discount_total
discount_total_formatted	subscriptions.discount_total_formatted
discount_percent	subscriptions.discount_percent
discount	subscriptions.discount
discount_applied_on_amount	subscriptions.discount_applied_on_amount
discount_type	subscriptions.discount_type
is_discount_before_tax	subscriptions.is_discount_before_tax
bcy_discount_total	subscriptions.bcy_discount_total
exchange_rate	subscriptions.exchange_rate
exchange_rate_formatted	subscriptions.exchange_rate_formatted
is_inclusive_tax	subscriptions.is_inclusive_tax
tax_rounding	subscriptions.tax_rounding
roundoff_value	subscriptions.roundoff_value
roundoff_value_formatted	subscriptions.roundoff_value_formatted
transaction_rounding_type	subscriptions.transaction_rounding_type
payment_terms	subscriptions.payment_terms
payment_terms_label	subscriptions.payment_terms_label
template_id	subscriptions.template_id
can_add_bank_account	subscriptions.can_add_bank_account
created_by_id	subscriptions.created_by_id
last_modified_by_id	subscriptions.last_modified_by_id
created_date	subscriptions.created_date
created_date_formatted	subscriptions.created_date_formatted
start_date	subscriptions.start_date
start_date_formatted	subscriptions.start_date_formatted
customer_id	subscriptions.customer_id
customer	subscriptions.customer
invoice_notes	subscriptions.invoice_notes
custom_fields	subscriptions.custom_fields
custom_field_hash	subscriptions.custom_field_hash
reactivate_date	subscriptions.reactivate_date
reactivate_date_formatted	subscriptions.reactivate_date_formatted
contactpersons	subscriptions.contactpersons
contact_persons_associated	subscriptions.contact_persons_associated
notes	subscriptions.notes
allow_partial_payments	subscriptions.allow_partial_payments
auto_apply_credits	subscriptions.auto_apply_credits
payment_gateways	subscriptions.payment_gateways
is_advance_invoice_present	subscriptions.is_advance_invoice_present
end_of_term_scheduled_date	subscriptions.end_of_term_scheduled_date
end_of_term_scheduled_date_formatted	subscriptions.end_of_term_scheduled_date_formatted
apply_changes_on	subscriptions.apply_changes_on
apply_changes_on_formatted	subscriptions.apply_changes_on_formatted
is_scheduled_update	subscriptions.is_scheduled_update
price_change_mode	subscriptions.price_change_mode
void_open_invoices_on_cancellation	subscriptions.void_open_invoices_on_cancellation
allow_in_term_reactivation	subscriptions.allow_in_term_reactivation
last_child_inv_balance	subscriptions.last_child_inv_balance
last_child_inv_balance_formatted	subscriptions.last_child_inv_balance_formatted
last_child_inv_status	subscriptions.last_child_inv_status
is_in_term_reactivation_scheduled	subscriptions.is_in_term_reactivation_scheduled
max_date_for_in_term	subscriptions.max_date_for_in_term

Get Subscriptions List

Retrieves multiple data points or a collection of records related to the current context. This method is useful for fetching lists, related records, or bulk data required for your widget's functionality.

Commonly used for :

• Fetch related records
• Retrieve collections of data
• Access lists or tables of information

Supported Locations :

subscriptions.list.buttonsubscriptions.bulkaction.buttonsubscriptions.list.sidebar

Sample Code :

REQUEST DETAILS

window.onload = function () {
  ZFAPPS.extension.init().then(function(App) {
    ZFAPPS.get('subscriptions').then(function (data) {
     //response Handling
    }).catch(function (err) {
     //error Handling
    });
  });
}

Supported Input Keys :

Property	Request
customer_id	subscriptions.customer_id
customer_name	subscriptions.customer_name
email	subscriptions.email
plan_name	subscriptions.plan_name
scheduled_cancellation_date	subscriptions.scheduled_cancellation_date
scheduled_cancellation_date_formatted	subscriptions.scheduled_cancellation_date_formatted
subscription_id	subscriptions.subscription_id
subscription_number	subscriptions.subscription_number
created_at	subscriptions.created_at
created_at_formatted	subscriptions.created_at_formatted

Show More Supported Input Keys

Property	Request
activated_at	subscriptions.activated_at
activated_at_formatted	subscriptions.activated_at_formatted
status	subscriptions.status
status_formatted	subscriptions.status_formatted
amount	subscriptions.amount
amount_formatted	subscriptions.amount_formatted
last_billing_at	subscriptions.last_billing_at
last_billing_at_formatted	subscriptions.last_billing_at_formatted
next_billing_at	subscriptions.next_billing_at
next_billing_at_formatted	subscriptions.next_billing_at_formatted
reference_id	subscriptions.reference_id
created_time	subscriptions.created_time
selected	subscriptions.selected

Set Subscriptions customfields

Specifically designed to update custom field values within the current context. This method allows your widget to target and modify custom fields without affecting standard fields, ensuring precise data management.

Commonly used for :

• Update custom field values
• Manage user-defined data points
• Ensure targeted updates to specific fields

Supported Locations :

subscriptions.creation.sidebar

Sample Code :

REQUEST DETAILS

window.onload = function () {
  ZFAPPS.extension.init().then(function(App) {
    ZFAPPS.set('subscriptions.<custom_field_api_name>',<value>).then(function (data) {
     //response Handling
    }).catch(function (err) {
     //error Handling
    });
  });
}