---
title: "Preview a configuration transfer, field by field"
description: "All-mode key only."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/businesses/preview-a-configuration-transfer"
---
# Preview a configuration transfer, field by field

> All-mode key only.

<api-operation method="POST" path="/v1/businesses/{biz}/transfer_configurations/preview">
<template v-slot:docs="">

No writes. Returns, for each pair (the test twins first when `include_test_twins` is set), every field the run would change from → to, the tax plan line by line, and the `blockers` that would refuse the run. Secrets show as `••••`. A live destination is planned as if the live override were granted; its override sections have status `needs_live_override`. Send `plan_digest` back in `live_override` to bind a run to this preview.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
</tbody>
</table>

## Headers

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        Idempotency-Key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Safely retry writes — repeats return the original response. If a write FAILED after it had already taken effect, that failure is what repeats: the key is spent, and a new attempt needs a new key.
    </td>
  </tr>
</tbody>
</table>

## Body

The request body is **required**.

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        destination_business
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The id of the business to copy the configuration to (biz_…).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sections
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The sections to copy. Omitted: catalog, coupons, tax_rates and settings.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        wipe_destination
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      True to clear the destination's existing configuration first. Test destinations only.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        numbering
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Prefixes to set on the destination. Omitted: the destination keeps its own. A prefix that another business uses, or that numbers already issued start with, is refused.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        numbering.invoice_prefix
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The destination's new invoice prefix.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        numbering.credit_note_prefix
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      The destination's new credit note prefix.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        include_test_twins
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Both businesses live: also copy the source's test business into the destination's test business, first.
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        transfer_preview
      </code>
      
      . One of <code>
        transfer_preview
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source_business
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The source business (biz_…).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        destination_business
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The destination business (biz_…).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        sections
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      The sections planned.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        plan_digest
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Binds a live-override run to this preview. Changes when the destination changes.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        live_override_available
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      The destination is live and the live override would change something.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        pairs
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      One plan per pair: the test twins first, then the main pair.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      The transfer preview
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        400
      </code>
    </td>
    
    <td>
      Invalid body, or test twins asked for without two live businesses
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        403
      </code>
    </td>
    
    <td>
      Requires an all-mode API key and the admin permission
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such destination business
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        409
      </code>
    </td>
    
    <td>
      Idempotency-Key conflict — the key is already in flight, or was reused with a different request payload.
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl -X POST "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/transfer_configurations/preview" \
  -H "Authorization: Bearer $TMBILLING_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "destination_business": "biz_XXXXXXXXXXXX01"
  }'
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "transfer_preview",
  "source_business": "biz_XXXXXXXXXXXX01",
  "destination_business": "biz_XXXXXXXXXXXX01",
  "sections": [
    "Section"
  ],
  "plan_digest": "Plan digest",
  "live_override_available": false,
  "pairs": [
    {
      "source_business": "Source business",
      "destination_business": "Destination business",
      "destination_name": "Destination name",
      "destination_livemode": "test",
      "clear_first": false,
      "blockers": [
        {
          "section": "Section",
          "message": "Requested by the customer."
        }
      ]
    }
  ]
}
```

```json [400 Bad Request]
{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid body, or test twins asked for without two live businesses"
  }
}
```

```json [403 Forbidden]
{
  "error": {
    "type": "permission_error",
    "message": "Requires an all-mode API key and the admin permission"
  }
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such destination business"
  }
}
```

```json [409 Conflict]
{
  "error": {
    "type": "idempotency_error",
    "message": "Idempotency-Key conflict — the key is already in flight, or was reused with a different request payload."
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.