Skip to content

Commit

Permalink
publish: Merge pull request #41 from Moesif/fix-typo-subscription
Browse files Browse the repository at this point in the history
generated from commit 109ce39
  • Loading branch information
moesif-ci-cd committed Jan 18, 2024
1 parent 1ee81f1 commit 02a4663
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4678,18 +4678,18 @@ <h3 id="update-a-subscription">Update a Subscription</h3>

<p><strong><code class="prettyprint">POST https://api.moesif.net/v1/subscriptions</code></strong></p>

<p>Updates a subscription for a subscription in Moesif. A subscription represents a single plan a customer is subscribed to and paying for. A company can have one or more subscriptions. Any custom subscription properties can be stored via the <code class="prettyprint">metadata</code> object. </p>
<p>Updates a subscription for a subscription in Moesif. A subscription represents a single plan a customer is subscribed to and paying for. A company can have one or more subscriptions. Any custom subscription properties can be stored via the <code class="prettyprint">metadata</code> object.</p>

<h4 id="create-vs-update">Create vs update</h4>

<p>If the subscription does not exist, Moesif will create a new one. </p>
<p>If the subscription does not exist, Moesif will create a new one.</p>

<p>If a subscription exists, the new subscription properties will be merged with the existing properties
recursively. This means you don&rsquo;t need to resend the entire subscription object if you are only
recursively. This means you don&rsquo;t need to resend the entire subscription object if you are only
updating a single field.</p>

<aside class="notice">
Replace <i>YOUR_COLLECTOR_APPLICATION_ID</i> with your real Application Id found by logging into Moesif
Replace <i>YOUR_COLLECTOR_APPLICATION_ID</i> with your real Application Id found by logging into Moesif
and selecting API keys from bottom left menu.
</aside>

Expand All @@ -4702,7 +4702,7 @@ <h4 id="create-vs-update">Create vs update</h4>
</span><span class="s2">"company_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"67890"</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Company</span><span class="w"> </span><span class="err">Id</span><span class="w">
</span><span class="s2">"current_period_start"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"current_period_end"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"subscription_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PAYG"</span><span class="p">,</span><span class="w">
</span><span class="s2">"subscription_tier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pro"</span><span class="p">,</span><span class="w">
Expand All @@ -4717,11 +4717,11 @@ <h4 id="create-vs-update">Create vs update</h4>
--header <span class="s1">'X-Moesif-Application-Id: YOUR_COLLECTOR_APPLICATION_ID'</span> <span class="se">\</span>
--header <span class="s1">'Content-Type: application/json'</span> <span class="se">\</span>
--data <span class="s1">'{
"subscription_id": "12345",
"company_id": "67890",
"subscription_id": "12345",
"company_id": "67890",
"current_period_start": "2024-01-21T17:32:28.000Z",
"current_period_end": "2024-11-21T17:32:28.000Z",
"status": "active",
"status": "active",
"metadata": {
"subscription_type": "PAYG",
"subscription_tier": "Pro",
Expand Down Expand Up @@ -4754,7 +4754,7 @@ <h4 id="subscription-ids">Subscription ids</h4>
<td>company_id</td>
<td>string</td>
<td><strong>true</strong></td>
<td>The unique identifier for the company this subscruiption should be associated with.</td>
<td>The unique identifier for the company this subscription should be associated with.</td>
</tr>
<tr>
<td>current_period_start</td>
Expand Down Expand Up @@ -4810,7 +4810,7 @@ <h3 id="update-companies-in-batch">Update Companies in Batch</h3>
</span><span class="s2">"company_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"67890"</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Company</span><span class="w"> </span><span class="err">Id</span><span class="w">
</span><span class="s2">"current_period_start"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"current_period_end"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"subscription_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PAYG"</span><span class="p">,</span><span class="w">
</span><span class="s2">"subscription_tier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pro"</span><span class="p">,</span><span class="w">
Expand All @@ -4825,7 +4825,7 @@ <h3 id="update-companies-in-batch">Update Companies in Batch</h3>
</span><span class="s2">"company_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"xyz"</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Company</span><span class="w"> </span><span class="err">Id</span><span class="w">
</span><span class="s2">"current_period_start"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"current_period_end"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-11-21T17:32:28.000Z"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
</span><span class="s2">"metadata"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"subscription_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PAYG"</span><span class="p">,</span><span class="w">
</span><span class="s2">"subscription_tier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enterprise"</span><span class="p">,</span><span class="w">
Expand All @@ -4841,11 +4841,11 @@ <h3 id="update-companies-in-batch">Update Companies in Batch</h3>
--header <span class="s1">'X-Moesif-Application-Id: YOUR_COLLECTOR_APPLICATION_ID'</span> <span class="se">\</span>
--header <span class="s1">'Content-Type: application/json'</span> <span class="se">\</span>
--data <span class="s1">'[{
"subscription_id": "12345",
"company_id": "67890",
"subscription_id": "12345",
"company_id": "67890",
"current_period_start": "2024-01-21T17:32:28.000Z",
"current_period_end": "2024-11-21T17:32:28.000Z",
"status": "active",
"status": "active",
"metadata": {
"subscription_type": "PAYG",
"subscription_tier": "Pro",
Expand Down Expand Up @@ -4878,7 +4878,7 @@ <h4 id="subscription-ids">Subscription ids</h4>
<td>company_id</td>
<td>string</td>
<td><strong>true</strong></td>
<td>The unique identifier for the company this subscruiption should be associated with.</td>
<td>The unique identifier for the company this subscription should be associated with.</td>
</tr>
<tr>
<td>current_period_start</td>
Expand Down

0 comments on commit 02a4663

Please sign in to comment.