shopify-api-types
Version:
typings for Shopify Admin API
15 lines • 10.3 kB
HTML
<html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>UsageCharge | Shopify API Types</title><meta name="description" content="Documentation for Shopify API Types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Shopify API Types</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Shopify API Types</a></li><li><a href="../modules/2021_01.html">2021/01</a></li><li><a href="2021_01.UsageCharge.html">UsageCharge</a></li></ul><h1>Interface UsageCharge</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#properties-2021-01">https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#properties-2021-01</a></p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UsageCharge</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#created_at" class="tsd-kind-icon">created_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#price" class="tsd-kind-icon">price</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#recurring_application_charge_id" class="tsd-kind-icon">recurring_<wbr/>application_<wbr/>charge_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#updated_at" class="tsd-kind-icon">updated_<wbr/>at</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="created_at" class="tsd-anchor"></a><h3>created_<wbr/>at</h3><div class="tsd-signature tsd-kind-icon">created_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L182">2021/01/payloads/billing.ts:182</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The date the usage charge was created</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="description" class="tsd-anchor"></a><h3>description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L186">2021/01/payloads/billing.ts:186</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The description of the usage charge</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L190">2021/01/payloads/billing.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The unique id of the usage charge</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="price" class="tsd-anchor"></a><h3>price</h3><div class="tsd-signature tsd-kind-icon">price<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L194">2021/01/payloads/billing.ts:194</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The price of the usage charge</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="recurring_application_charge_id" class="tsd-anchor"></a><h3>recurring_<wbr/>application_<wbr/>charge_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">recurring_<wbr/>application_<wbr/>charge_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L198">2021/01/payloads/billing.ts:198</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The unique id of the recurring application charge the usage charge belongs to</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="updated_at" class="tsd-anchor"></a><h3>updated_<wbr/>at</h3><div class="tsd-signature tsd-kind-icon">updated_<wbr/>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/billing.ts#L202">2021/01/payloads/billing.ts:202</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The date the usage charge was last updated</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/2021_01.html">2021/01</a></li><li class=" tsd-kind-module"><a href="../modules/common.html">common</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="2021_01.UsageCharge.html" class="tsd-kind-icon">Usage<wbr/>Charge</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#created_at" class="tsd-kind-icon">created_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#price" class="tsd-kind-icon">price</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#recurring_application_charge_id" class="tsd-kind-icon">recurring_<wbr/>application_<wbr/>charge_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.UsageCharge.html#updated_at" class="tsd-kind-icon">updated_<wbr/>at</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>