Using Chargebee actions in action flows

<body>
<p id="docs-hc-snippet" style="display: none;">Before you can include external actions in your action flows, you must connect the action builder to the external system.</p>
<div class="article-banners">
<div id="docs-wmp-link">
<a href="https://support.zendesk.com/hc/en-us/articles/5411234991258-plan" rel="noopener" target="_blank">What's my plan?</a>
</div>
<div class="article-banner" id="suite_all">
<table>
<tbody>
<tr>
<td>
<strong>All Suites</strong>
</td>
<td>Team, Growth, Professional, Enterprise, or Enterprise Plus</td>
</tr>
</tbody>
</table>
</div>
<div class="article-banner" id="support_all">
<table>
<tbody>
<tr>
<td>
<strong>Support</strong>
</td>
<td>Team, Professional, or Enterprise</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="docs-ai-summary">
<p id="docs-ai-summary-toggle">Summary: <span id="up-triangle">◀</span><span id="down-triangle">▼</span></p>
<p id="docs-ai-summary-content">You can connect action flows to Chargebee to automate customer and subscription management tasks like creating, updating, and looking up customers and subscriptions. Actions also include pausing, resuming, canceling subscriptions, retrieving invoices, and creating credit notes. Use a dedicated service account for connections and manage API keys securely to maintain control and security in your automated workflows.</p>
</div>
<div class="body">
<div class="p">By connecting the <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/8855513857306" target="_blank">action builder</a> to external systems, such as Chargebee,
admins can integrate Zendesk with external systems in automated workflows, improving
collaboration and maintaining a seamless experience across multiple platforms.<div class="note" id="zug_action_flow_external_Chargebee__note_i2z_jtz_v3c">
<span class="notetitle">Note:</span> The steps associated with external systems in action flows are
referred to collectively as <em class="ph i">external actions</em>.</div>
</div>
<div class="p">This article contains the following topics:<ul class="ul" id="zug_action_flow_external_Chargebee__ul_ysp_sn4_zgc">
<li class="li"><a class="xref" href="#topic_fcs_gtn_g3c">Connecting Chargebee to action builder</a></li>
<li class="li"><a class="xref" href="#topic_z1q_htn_g3c">Using Chargebee actions in action flows</a></li>
</ul>
</div>
</div>
<div aria-labelledby="ariaid-title2" class="topic nested1" id="topic_fcs_gtn_g3c">
<h2 class="title topictitle2" id="ariaid-title2">Connecting Chargebee to action builder</h2>
<div class="body">
<p class="p">Before you can include external actions in your action flows, you must connect the
action builder to the external system.</p>
<div class="p">When connecting to external systems for use in action flows, the following best practices are recommended:<ul class="ul" id="topic_fcs_gtn_g3c__d8e13">
<li class="li">All external actions performed by an action flow are attributed to the user who connected the
external system. Therefore, it's a best practice to use a dedicated service
account rather than personal credentials when connecting to each external
system.</li>
<li class="li">All integrations request access to necessary scopes. However, it's important that you review and validate the scopes before authorizing the connection to the external system.</li>
<li class="li">When managing credentials for API key-based tools, such as OpenAI, it's best to store keys in a secure vault or credential manager.</li>
</ul>
</div>
<div class="p">
<strong class="ph b">To connect action builder to Chargebee</strong><ol class="ol" id="topic_fcs_gtn_g3c__ol_psh_lk4_zgc">
<li class="li"><span class="ph">In <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/4581766374554#topic_hfg_dyz_1hb" target="_blank">Admin Center</a>, click <img class="image" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/ac_apps_integrations_icon.png">
<strong class="ph b">Apps and integrations</strong> in the sidebar, then select <strong class="ph b">Actions &gt; Action
flows</strong>.</span></li>
<li class="li">
<a class="xref" href="https://support.zendesk.com/hc/en-us/articles/8855601898266" target="_blank">Create</a> or <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9052312956570" target="_blank">edit</a> an action flow.</li>
<li class="li">Open the step sidebar.</li>
<li class="li">Under <strong class="ph b">External actions</strong>, click <strong class="ph b">Chargebee</strong>.</li>
<li class="li">Click <strong class="ph b">Connect</strong>.</li>
<li class="li">Follow the Chargebee prompts to authenticate and complete the connection.
<p class="p">The Chargebee connection requires an API key for authentication.
You'll need to provide:</p>
<ul class="ul" id="topic_fcs_gtn_g3c__ul_prz_ddw_pjc">
<li class="li">Chargebee Site Name: Your Chargebee subdomain (for example, "acme"
for acme.chargebee.com)</li>
<li class="li">API key: Found in your Chargebee dashboard under <strong class="ph b">Settings</strong> &gt;
<strong class="ph b">Configure Chargebee</strong> &gt; <strong class="ph b">API Keys</strong>. </li>
</ul>
<div class="note" id="topic_fcs_gtn_g3c__note_ilr_mtz_v3c">
<span class="notetitle">Note:</span> All external actions performed by an action
flow are attributed to the user who connected the external system.
Therefore, it is a best practice to use a dedicated service account
rather than personal credentials when connecting to each external
system.</div>
</li>
</ol>
</div>
<p class="p">After you've connected to the system, you'll see an indicator that it's connected and
details about the instance you're connected to, as well as the actions available for
Chargebee.</p>
</div>
</div>
<div aria-labelledby="ariaid-title3" class="topic nested1" id="topic_z1q_htn_g3c">
<h2 class="title topictitle2" id="ariaid-title3">Using Chargebee actions in action flows</h2>
<div class="body">
<div class="p">The following Chargebee actions are available:<ul class="ul" id="topic_z1q_htn_g3c__ul_jby_q44_zgc">
<li class="li"><a class="xref" href="#topic_lck_r44_zgc">Create customer</a></li>
<li class="li"><a class="xref" href="#topic_epg_35z_v3c">Update customer</a></li>
<li class="li"><a class="xref" href="#topic_vmc_h5z_v3c">Lookup customer</a></li>
<li class="li"><a class="xref" href="#topic_alf_24q_jjc">Create
subscription</a></li>
<li class="li"><a class="xref" href="#topic_mjr_j4q_jjc">Update
subscription</a></li>
<li class="li"><a class="xref" href="#topic_wfm_m4q_jjc">Lookup
subscription</a></li>
<li class="li"><a class="xref" href="#topic_vmr_lkz_jjc">Pause subscription</a></li>
<li class="li"><a class="xref" href="#topic_lqp_skz_jjc">Resume
subscription</a></li>
<li class="li"><a class="xref" href="#topic_lvn_1nz_jjc">Cancel
subscription</a></li>
<li class="li"><a class="xref" href="#topic_lyl_jnz_jjc">Retrieve invoice</a></li>
<li class="li"><a class="xref" href="#topic_w5w_cd1_kjc">Create credit note</a></li>
</ul>
</div>
</div>
<div aria-labelledby="ariaid-title4" class="topic nested2" id="topic_lck_r44_zgc">
<h3 class="title topictitle3" id="ariaid-title4">Creating a customer</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Create customer</em> action to create a new customer record in
Chargebee.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_lck_r44_zgc__table_dgb_n11_w3c" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e253" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e255" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e253" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e255" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Email</code><p class="p">Optional:
<code class="ph codeph">First name</code>, <code class="ph codeph">Last
name</code>, <code class="ph codeph">Company</code>,
<code class="ph codeph">Phone</code></p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e253" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e255" style="text-align:left;vertical-align:top;">Customer details including id, email, first_name,
last_name, created_at, and object type.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title5" class="topic nested2" id="topic_epg_35z_v3c">
<h3 class="title topictitle3" id="ariaid-title5">Updating a customer</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Update customer</em> action to update an existing customer's
information.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_epg_35z_v3c__table_xf2_1jz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e331" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e333" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e331" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e333" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Customer ID</code><p class="p">Optional:
<code class="ph codeph">Email</code>, <code class="ph codeph">First name</code>,
<code class="ph codeph">Last name</code>,
<code class="ph codeph">Company</code>,
<code class="ph codeph">Phone</code></p>
<p class="p">Only the Customer ID is
required. Provide only the fields you want to update.
Existing values for fields you don't specify will remain
unchanged.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e331" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e333" style="text-align:left;vertical-align:top;">Customer details including id, email, first_name,
last_name, and updated_at timestamp.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title6" class="topic nested2" id="topic_vmc_h5z_v3c">
<h3 class="title topictitle3" id="ariaid-title6">Looking up a customer</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Lookup customer</em> action to find a customer by customer ID or email
address.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_vmc_h5z_v3c__table_qtw_kjz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e414" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e416" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e414" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e416" style="text-align:left;vertical-align:top;">Optional: <code class="ph codeph">Email</code>, <code class="ph codeph">Customer
ID</code><p class="p">Provide either Email or Customer ID to
look up a customer. If both are provided, Customer ID
takes precedence. At least one field is
required.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e414" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e416" style="text-align:left;vertical-align:top;">Customer details including id, email, first_name,
last_name, company, phone, created_at, updated_at,
auto_collection, taxability, locale, deleted status,
vat_number, net_term_days, and allow_direct_debit.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title7" class="topic nested2" id="topic_alf_24q_jjc">
<h3 class="title topictitle3" id="ariaid-title7">Creating a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Create subscription</em> action to create a new recurring subscription
for a customer.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_alf_24q_jjc__table_yhf_pjz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e485" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e487" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e485" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e487" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Customer ID</code>,
<code class="ph codeph">Plan</code><p class="p">The Plan field allows you to
select from your available Chargebee pricing
plans.</p>
<p class="p">Optional: <code class="ph codeph">Plan quantity</code>,
<code class="ph codeph">Trial end date</code>, <code class="ph codeph">Start
date</code></p>
<p class="p">Plan quantity defaults to 1 if
not specified. Trial end date and Start date should be
in YYYY-MM-DD format. </p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e485" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e487" style="text-align:left;vertical-align:top;">Subscription details including id, customer_id, plan_id,
status, current_term_start, current_term_end, created_at,
activated_at, started_at, next_billing_at, trial_start,
trial_end, billing_period, billing_period_unit,
currency_code, auto_collection, and mrr (monthly recurring
revenue).</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title8" class="topic nested2" id="topic_mjr_j4q_jjc">
<h3 class="title topictitle3" id="ariaid-title8">Updating a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Update subscription</em> action to change a subscription's plan or
quantity.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_mjr_j4q_jjc__table_n25_xjz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e567" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e569" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e567" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e569" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Subscription ID</code>,
<code class="ph codeph">Plan</code><p class="p">Optional: <code class="ph codeph">Plan
quantity</code>, <code class="ph codeph">Proration</code>,
<code class="ph codeph">End of term</code></p>
<p class="p">Proration
determines whether a prorated invoice is generated
immediately for the price difference. End of term
determines whether the change takes effect immediately
or at the end of the current billing period. Both
default to false (immediate change with no
proration).</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e567" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e569" style="text-align:left;vertical-align:top;">Subscription details including id, customer_id, plan_id,
status, and updated_at timestamp.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title9" class="topic nested2" id="topic_wfm_m4q_jjc">
<h3 class="title topictitle3" id="ariaid-title9">Looking up a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Lookup subscription</em> action to find a subscription by subscription
ID or customer ID.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_wfm_m4q_jjc__table_zlg_ckz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e647" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e649" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e647" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e649" style="text-align:left;vertical-align:top;">Optional: <code class="ph codeph">Customer ID</code>,
<code class="ph codeph">Subscription ID</code><p class="p">Provide either
Customer ID or Subscription ID to look up a
subscription. If both are provided, Subscription ID
takes precedence. At least one field is
required.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e647" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e649" style="text-align:left;vertical-align:top;">Subscription details including id, customer_id, plan_id,
status, current_term_start, current_term_end, created_at,
activated_at, started_at, updated_at, next_billing_at,
trial_start, trial_end, cancelled_at, cancel_reason,
billing_period, billing_period_unit, currency_code,
auto_collection, mrr, due_invoices_count, and total_dues. </td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title10" class="topic nested2" id="topic_vmr_lkz_jjc">
<h3 class="title topictitle3" id="ariaid-title10">Pausing a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Pause subscription</em> action to temporarily pause a subscription.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_vmr_lkz_jjc__table_wmr_lkz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e717" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e719" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e717" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e719" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Subscription ID</code><p class="p">Optional:
<code class="ph codeph">Pause option</code>, <code class="ph codeph">Resume
date</code></p>
<p class="p">Pause option determines whether
to pause immediately or at the end of the current
billing term. Resume date should be in YYYY-MM-DD format
and specifies when the subscription should automatically
resume.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e717" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e719" style="text-align:left;vertical-align:top;">Subscription details including id, status, pause_date,
and resume_date timestamps.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title11" class="topic nested2" id="topic_lqp_skz_jjc">
<h3 class="title topictitle3" id="ariaid-title11">Resuming a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Resume subscription</em> action to resume a paused subscription.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_lqp_skz_jjc__table_nqp_skz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e791" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e793" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e791" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e793" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Subscription ID</code><p class="p">Optional:
<code class="ph codeph">Resume option</code>, <code class="ph codeph">Resume
date</code></p>
<p class="p">Resume option determines whether
to resume immediately or on a specific date. If Resume
option is "Specific date", you must provide a Resume
date in YYYY-MM-DD format.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e791" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e793" style="text-align:left;vertical-align:top;">Subscription details including id, status, and
resume_date timestamp.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title12" class="topic nested2" id="topic_lvn_1nz_jjc">
<h3 class="title topictitle3" id="ariaid-title12">Canceling a subscription</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Cancel subscription</em> action to cancel a subscription.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_lvn_1nz_jjc__table_nvn_1nz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e865" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e867" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e865" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e867" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Subscription ID</code><p class="p">Optional:
<code class="ph codeph">Cancel at end of term</code>,
<code class="ph codeph">Cancellation reason</code>,
<code class="ph codeph">Comment</code></p>
<p class="p">Cancel at end of term
determines whether to cancel immediately or at the end
of the billing term (defaults to true). Cancellation
reason includes options such as Not paid, No card,
Fraud, Free account, and Other. Use Comment to provide
additional context about the cancellation.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e865" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e867" style="text-align:left;vertical-align:top;">Subscription details including id, status, cancelled_at,
and scheduled_cancellation_date timestamps.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title13" class="topic nested2" id="topic_lyl_jnz_jjc">
<h3 class="title topictitle3" id="ariaid-title13">Retrieving an invoice</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Retrieve invoice</em> action to get detailed information about a
specific invoice.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_lyl_jnz_jjc__table_myl_jnz_jjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e943" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e945" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e943" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e945" style="text-align:left;vertical-align:top;">
<p class="p">Required: <code class="ph codeph">Invoice ID</code></p>
<p class="p">The Invoice ID field dynamically populates with available
invoices from your Chargebee account.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e943" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e945" style="text-align:left;vertical-align:top;">Invoice details including id, customer_id,
subscription_id, status, total, amount_paid, amount_due,
currency_code, date, due_date, and pdf_url.<p class="p"> The pdf_url
provides a direct link to download the invoice
PDF.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title14" class="topic nested2" id="topic_w5w_cd1_kjc">
<h3 class="title topictitle3" id="ariaid-title14">Creating a credit note</h3>
<div class="body">
<p class="p">Use the <em class="ph i">Create credit note</em> action to issue a refund or adjustment credit
note against an invoice.</p>
<p class="p">This action has the following inputs and outputs:</p>
<div class="p">
<div class="tablenoborder">
<table border="1" cellpadding="4" cellspacing="0" class="table" frame="border" id="topic_w5w_cd1_kjc__table_x5w_cd1_kjc" rules="all" summary="">
<colgroup>
<col>
<col>
</colgroup>
<thead class="thead" style="text-align:left;">
<tr class="row">
<th class="entry cellrowborder" id="d89e1016" style="text-align:left;vertical-align:top;"> </th>
<th class="entry cellrowborder" id="d89e1018" style="text-align:left;vertical-align:top;">Variables</th>
</tr>
</thead>
<tbody class="tbody">
<tr class="row">
<td class="entry cellrowborder" headers="d89e1016" style="text-align:left;vertical-align:top;">Inputs</td>
<td class="entry cellrowborder" headers="d89e1018" style="text-align:left;vertical-align:top;">Required: <code class="ph codeph">Invoice ID</code>,
<code class="ph codeph">Type</code>, <code class="ph codeph">Total (in
cents)</code>, <code class="ph codeph">Reason code</code><p class="p">Optional:
<code class="ph codeph">Comment</code></p>
<p class="p">Type can be
Refundable (for refunds) or Adjustment (for account
adjustments). Total is in cents (e.g., 1000 = $10.00).
For refundable credit notes, total must not exceed the
refundable amount on the invoice. For adjustment credit
notes, total must not exceed the amount due. Reason code
must match a reason code configured in your Chargebee
account.</p>
</td>
</tr>
<tr class="row">
<td class="entry cellrowborder" headers="d89e1016" style="text-align:left;vertical-align:top;">Output</td>
<td class="entry cellrowborder" headers="d89e1018" style="text-align:left;vertical-align:top;">Credit note details including id, customer_id,
reference_invoice_id, type, status, total, currency_code,
date, and reason_code.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<script id="docs-schema-markup" type="application/ld+json">{
"@context": "https://schema.org",
"@type": "TechArticle",
"@id": "https://support.zendesk.com/hc/en-us/articles/10916686675098-Using-Chargebee-actions-in-action-flows",
"url": "https://support.zendesk.com/hc/en-us/articles/10916686675098-Using-Chargebee-actions-in-action-flows",
"headline": "Using Chargebee actions in action flows",
"description": "You can connect an action builder to Chargebee to automate workflows by creating, updating, and managing customers, subscriptions, invoices, and credit notes through external actions in action flows.",
"articleSection": "Product help",
"datePublished": "2026-06-18T17:30:14.778910+00:00",
"dateModified": "2026-06-18T17:30:17.456648+00:00",
"inLanguage": "en-US",
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://support.zendesk.com/hc/en-us/articles/10916686675098-Using-Chargebee-actions-in-action-flows"
},
"author": {
"@type": "Organization",
"name": "Zendesk",
"url": "https://www.zendesk.com"
},
"publisher": {
"@type": "Organization",
"name": "Zendesk"
},
"isPartOf": {
"@type": "WebSite",
"name": "Zendesk Help",
"url": "https://support.zendesk.com/hc/en-us"
},
"about": {
"@type": "SoftwareApplication",
"name": "Zendesk"
}
}</script><script id="ai-summary-script">
//<![CDATA[
const ai_summary_style = document.createElement('style');
ai_summary_style.innerHTML = `#styled-article-body{padding:0 0 0}#article-body #docs-ai-summary{background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 6px;margin-bottom:16px}#article-body #docs-ai-summary #docs-ai-summary-toggle{font-size:.9em;font-weight:700;margin-bottom:4px;cursor:pointer;display:flex;justify-content:space-between;align-items:center}#article-body #docs-ai-summary #docs-ai-summary-toggle #up-triangle{margin-left:auto;padding-right:10px;display:none}#article-body #docs-ai-summary #docs-ai-summary-toggle #down-triangle{margin-left:auto;padding-right:10px}#article-body #docs-ai-summary #docs-ai-summary-content{font-size:.9em;padding-left:25px;padding-right:25px;margin-bottom:12px}`;
document.head.appendChild(ai_summary_style);

const toggleAISummary = () => {
const summary = document.getElementById("docs-ai-summary-content");
const upTriangle = document.getElementById("up-triangle");
const downTriangle = document.getElementById("down-triangle");
if (summary.style.display === "none") {
summary.style.display = "block";
upTriangle.style.display = "none";
downTriangle.style.display = "inline";
} else {
summary.style.display = "none";
upTriangle.style.display = "inline";
downTriangle.style.display = "none";
}
};

document.getElementById("docs-ai-summary-toggle").addEventListener("click", toggleAISummary);
//]]>
</script>
</body>