---
title: "Customers"
description: "The payer: who they are, where they are (which decides their tax), and what they are owed."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/customers"
---
# Customers

> The payer: who they are, where they are (which decides their tax), and what they are owed.

The payer: who they are, where they are (which decides their tax), and what they are owed.

A customer can carry money in three distinct forms, and they are not interchangeable. **Promotional credit** is goodwill you granted — it reduces invoices and is never refundable. **Excess payment** is real money they overpaid, held until an invoice needs it. A **wallet** is prepaid balance, which may have been paid for or granted. An invoice draws on them in a fixed order, so the same total settles the same way every time.

Archiving a customer is soft and reversible. `clear_personal_data` is not: it redacts the personal fields in place for erasure requests and detaches every vaulted instrument. The ledger, invoices and payments are left intact — the ledger is append-only and the numbers still have to add up.

## Endpoints

<table>
<thead>
  <tr>
    <th>
      Method
    </th>
    
    <th>
      Endpoint
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/list-customers">
        <code>
          /v1/businesses/{biz}/customers
        </code>
      </a>
    </td>
    
    <td>
      List customers
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/create-a-customer">
        <code>
          /v1/businesses/{biz}/customers
        </code>
      </a>
    </td>
    
    <td>
      Create a customer
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/get-a-customer">
        <code>
          /v1/businesses/{biz}/customers/{cus}
        </code>
      </a>
    </td>
    
    <td>
      Get a customer
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        PATCH
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/edit-a-customer">
        <code>
          /v1/businesses/{biz}/customers/{cus}
        </code>
      </a>
    </td>
    
    <td>
      Edit a customer
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DELETE
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/archive-a-customer">
        <code>
          /v1/businesses/{biz}/customers/{cus}
        </code>
      </a>
    </td>
    
    <td>
      Archive a customer
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/change-the-customer-s-calendar-billing-anchor">
        <code>
          /v1/businesses/{biz}/customers/{cus}/change_billing_date
        </code>
      </a>
    </td>
    
    <td>
      Change the customer's calendar billing anchor
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/clear">
        <code>
          /v1/businesses/{biz}/customers/{cus}/clear_personal_data
        </code>
      </a>
    </td>
    
    <td>
      Clear (redact) the customer's personal data
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/collect-an-ad-hoc-payment">
        <code>
          /v1/businesses/{biz}/customers/{cus}/collect_payment
        </code>
      </a>
    </td>
    
    <td>
      Collect an ad-hoc payment
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/list-a-customer-s-additional-contacts">
        <code>
          /v1/businesses/{biz}/customers/{cus}/contacts
        </code>
      </a>
    </td>
    
    <td>
      List a customer's additional contacts
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/add-an-additional-contact">
        <code>
          /v1/businesses/{biz}/customers/{cus}/contacts
        </code>
      </a>
    </td>
    
    <td>
      Add an additional contact
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        PATCH
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/edit-an-additional-contact">
        <code>
          /v1/businesses/{biz}/customers/{cus}/contacts/{con}
        </code>
      </a>
    </td>
    
    <td>
      Edit an additional contact
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DELETE
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/delete-an-additional-contact">
        <code>
          /v1/businesses/{biz}/customers/{cus}/contacts/{con}
        </code>
      </a>
    </td>
    
    <td>
      Delete an additional contact
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/retrieve-usage-so-far-for-each-of-a-customer-s-m">
        <code>
          /v1/businesses/{biz}/customers/{cus}/current_usage
        </code>
      </a>
    </td>
    
    <td>
      Retrieve usage so far for each of a customer's metered subscriptions
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/payments-holding-the-customer-s-excess-credit">
        <code>
          /v1/businesses/{biz}/customers/{cus}/excess_payments
        </code>
      </a>
    </td>
    
    <td>
      Payments holding the customer's excess credit
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/list-promotional-credit-movements">
        <code>
          /v1/businesses/{biz}/customers/{cus}/promotional_credits
        </code>
      </a>
    </td>
    
    <td>
      List promotional-credit movements
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/add">
        <code>
          /v1/businesses/{biz}/customers/{cus}/promotional_credits
        </code>
      </a>
    </td>
    
    <td>
      Add, deduct, or set a customer's promotional credit balance
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/get-one-promotional-credit-movement">
        <code>
          /v1/businesses/{biz}/customers/{cus}/promotional_credits/{id}
        </code>
      </a>
    </td>
    
    <td>
      Get one promotional-credit movement
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/record-an-excess">
        <code>
          /v1/businesses/{biz}/customers/{cus}/record_excess_payment
        </code>
      </a>
    </td>
    
    <td>
      Record an excess (unapplied) payment as customer credit
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/list-a-customer-s-shipping-addresses">
        <code>
          /v1/businesses/{biz}/customers/{cus}/shipping_addresses
        </code>
      </a>
    </td>
    
    <td>
      List a customer's shipping addresses
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/add-a-shipping-address">
        <code>
          /v1/businesses/{biz}/customers/{cus}/shipping_addresses
        </code>
      </a>
    </td>
    
    <td>
      Add a shipping address
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        PATCH
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/edit-a-shipping-address">
        <code>
          /v1/businesses/{biz}/customers/{cus}/shipping_addresses/{addr}
        </code>
      </a>
    </td>
    
    <td>
      Edit a shipping address
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/archive-a-shipping-address">
        <code>
          /v1/businesses/{biz}/customers/{cus}/shipping_addresses/{addr}/archive
        </code>
      </a>
    </td>
    
    <td>
      Archive a shipping address
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/restore-an-archived-shipping-address">
        <code>
          /v1/businesses/{biz}/customers/{cus}/shipping_addresses/{addr}/restore
        </code>
      </a>
    </td>
    
    <td>
      Restore an archived shipping address
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/validate-the-customer-s-stored-vat-number">
        <code>
          /v1/businesses/{biz}/customers/{cus}/validate_vat
        </code>
      </a>
    </td>
    
    <td>
      Validate the customer's stored VAT number
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/get-a-customer-wallet-balance">
        <code>
          /v1/businesses/{biz}/customers/{cus}/wallet
        </code>
      </a>
    </td>
    
    <td>
      Get a customer wallet balance
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/customers/top-up-a-customer-wallet">
        <code>
          /v1/businesses/{biz}/customers/{cus}/wallet/topup
        </code>
      </a>
    </td>
    
    <td>
      Top up a customer wallet
    </td>
  </tr>
</tbody>
</table>


## Sitemap

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