Select a request body example

<p>
  All of the request body examples listed below can be selected from the <strong>EXAMPLES</strong> drop-down menu in the top-right corner of the <strong>Try It!</strong> feature.
</p>

<Image
  align="center"
  className="border"
  border={true}
  src="https://files.readme.io/cf09bebcdfcb05f20a3e06592e3964056554874efaf3ce9295ab35d0dc6e5b79-Screenshot_2025-01-29_at_4.33.58_PM.png"
/>

<br />
<br />

<table border="1" cellSpacing="0" cellPadding="8">
  <thead>
    <tr>
      <th><b>Request Body Example</b></th>
      <th><b>Use Case</b></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><b>Modify Product for Subscription</b></td>
      <td>Update the primary product, change the quantity, or apply/remove a coupon for an active subscription.</td>
    </tr>
    <tr>
      <td><b>Modify Next Charge Date</b></td>
      <td>Change the next charge date or end date of a subscription, and modify the product, quantity, or apply/remove a coupon (proration is not supported).</td>
    </tr>
    <tr>
      <td><b>Modify Price or Apply Discount</b></td>
      <td>Adjust the price of an active subscription without changing the product.</td>
    </tr>
    <tr>
      <td><b>Discount with Amount Off</b></td>
      <td>Apply a fixed amount discount to a subscription for a set duration.</td>
    </tr>
    <tr>
      <td><b>Discount with Percent Off</b></td>
      <td>Apply a percentage-based discount to a subscription for a specific number of billing periods or indefinitely.</td>
    </tr>
    <tr>
      <td><b>Preview Proration</b></td>
      <td>Preview prorated charges and credits before making actual changes to a subscription, aiding in estimating price changes due to upgrades or downgrades.</td>
    </tr>
    <tr>
      <td><b>Add or Edit Subscription Add-on</b></td>
      <td>Add a new subscription add-on or modify the quantity and pricing of an existing add-on.</td>
    </tr>
    <tr>
      <td><b>Remove a Subscription Add-on</b></td>
      <td>Remove an add-on from a subscription by setting its quantity to 0.</td>
    </tr>
    <tr>
      <td><b>Resume a Canceled Subscription</b></td>
      <td>Reactivate a subscription that was canceled but has not yet been deactivated.</td>
    </tr>
    <tr>
      <td><b>Switch to Manual Renewal</b></td>
      <td>Switch a subscription from automatic renewal to manual renewal, requiring the buyer to manually pay each period.</td>
    </tr>
    <tr>
      <td><b>Set End Date and Remaining Periods</b></td>
      <td>Set a fixed end date or define the number of remaining billing periods before a subscription stops renewing.</td>
    </tr>
    <tr>
      <td><b>Renew Subscription Indefinitely</b></td>
      <td>Remove an existing end date or remaining periods so the subscription renews indefinitely.</td>
    </tr>
    <tr>
      <td><b>Add or Update Tax Exemption ID</b></td>
      <td>Add or update a tax exemption ID for a subscription to apply tax exemption rules.</td>
    </tr>
    <tr>
      <td><b>Remove Tax Exemption ID</b></td>
      <td>Remove an existing tax exemption ID from a subscription by providing an empty string as the value.</td>
    </tr>
  </tbody>
</table>

<br />