> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Fields related to Prepaid with Drawdown

> This reference lists the fields related to the Prepaid with Drawdown feature.

This reference lists the fields related to the Prepaid with Drawdown feature.

> **Note**
>
> These fields are only available if you have the Prepaid with Drawdown feature enabled.

<table>
  <tr>
    <th>
      **Name**
    </th>

    <th>
      **Required to create?**
    </th>

    <th>
      **Allowed operations**
    </th>

    <th>
      **Description**
    </th>
  </tr>

  <tr>
    <td>
      IsPrepaid
    </td>

    <td>
      Required
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      Indicates whether this charge is a prepayment (topup) charge or a drawdown charge.

      **Type**: boolean **Character limit**: 5 **Version notes**: WSDL 114+ **Values**: `true` or `false`
    </td>
  </tr>

  <tr>
    <td>
      PrepaidOperationType
    </td>

    <td>
      Required
    </td>

    <td>
      Create Query
    </td>

    <td>
      The type of this charge. It is either a prepayment (topup) charge or a drawdown charge.

      **Type**: string(enum) **Character limit**: - - **Version notes**: WSDL 114+ **Values**: `topup` or `drawdown`
    </td>
  </tr>

  <tr>
    <td>
      PrepaidQuantity
    </td>

    <td>
      Optional (Required for prepayment charge)
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      The number of units included in a prepayment charge.

      **Type**: decimal **Character limit**: 22 **Version notes**: WSDL 114+ **Values**: must be a positive number (>0). `Null` for drawdown charge.
    </td>
  </tr>

  <tr>
    <td>
      PrepaidTotalQuantity
    </td>

    <td>
      Optional
    </td>

    <td>
      Query
    </td>

    <td>
      The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge.

      **Type**: decimal **Character limit**: 22 **Version notes**: WSDL 114+ **Values**: calculated with the formula “PrepaidQuantity \* Default Quantity”. Only available for prepayment charge. `Null` for drawdown charge.
    </td>
  </tr>

  <tr>
    <td>
      PrepaidUom
    </td>

    <td>
      Optional (Required for prepayment charge)
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      Unit of measurement for a prepayment charge.

      **Type**: string **Character limit**: – **Version notes**: WSDL 114+ **Values**: a configured unit of measure, such as Each.
    </td>
  </tr>

  <tr>
    <td>
      ValidityPeriodType
    </td>

    <td>
      Optional (Required for prepayment charge)
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      The period in which the prepayment units are valid to use as defined in a prepayment charge.

      **Type**: enum **Character limit**: – **Version notes**: WSDL 114+ **Values**: One of the following:

      * `Subscription_Term`
      * `Annual`
      * `Semi_Annual`
      * `Quarter`
      * `Month`
    </td>
  </tr>

  <tr>
    <td>
      CreditOption
    </td>

    <td>
      Optional
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      The way to calculate credit.

      **Type**: enum **Character limit**: – **Version notes**: WSDL 114+ **Values**: One of the following:

      * `TimeBased`
      * `ConsumptionBased`
      * `FullCreditBack`
    </td>
  </tr>

  <tr>
    <td>
      DrawdownRate
    </td>

    <td>
      Optional
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      The conversion rate between DrawdownUom and UOM in a drawdown charge, as follows: `DrawdownRate = DrawdownUom/UOM`

      * DrawdownUom is set in the drawdown charge, but you should set this field to the same as the prepayment charge's UOM, which corresponds to the PrepaidUom field of the prepayment charge.
      * UOM is the drawdown (usage) charge's UOM, which corresponds the UOM field of the drawdown charge.

      **Type**: decimal **Character limit**: – **Version notes**: WSDL 114+ **Values**:

      * Must be a positive number (>0).
      * Drawdown Rate must be 1 when Drawdown UOM is the same as Usage UOM.
      * If both DrawdownRate and DrawdownUOM are empty, the system will set default values respectively:

        * DrawdownRate: 1
        * DrawdownUOM: Same as the Usage UOM of this drawdown charge.
      * DrawdownRate and DrawdownUOM need to have values or be empty at the same time.
    </td>
  </tr>

  <tr>
    <td>
      DrawdownUom
    </td>

    <td>
      Optional (Required for drawdown charge)
    </td>

    <td>
      Create Update Query
    </td>

    <td>
      The unit of measurement that is configured in a drawdown charge. You should set this field to be the same as the PrepaidUom field of the corresponding prepayment charge. Note that the unit of measurement for the usage is configured in the UOM field of your drawdown charge.

      **Type**: string **Character limit**: – **Version notes**: WSDL 114+ **Values**: a configured unit of measure, such as Each.
    </td>
  </tr>
</table>