> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Third Party Billing

A Third Party Billing Account Group represents a group of third party billing accounts. Each group can have one account per carrier/warehouse combination. Groups can be be assigned to an order using `order.options.tpb_group_id`.

## Methods

* [tpb\_group.list](#tpb-group-list)

***

## Entity Properties

* [Third Party Billing Account Group](#tpb-group-properties)

***

## `tpb_group.list`

`tpb_group.list()`

Retrieve a list of Third Party Billing Groups. Use the `tpb_group_id` to instruct an order to be shipped on the appropriate third party billing account within the group.

### Parameters

The method is used without parameters.

### Return Value

An array of objects. Each object will contain [Third Party Billing Group Properties](#tpb-group-properties).

### Example Request

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "tpb_group.list",
        []
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "tpb_group_id" : 73,
            "label" : "TPB Group A",
            "status" : "active",
            "payment_types" : ["shipping"],
            "pva_id" : null,
            "ioss_id" : null,
            "voec_id" : null
        },
        {
            "tpb_group_id" : 74,
            "label" : "TPB Group B",
            "status" : "pending_approval",
            "payment_types" : ["shipping", "duties_and_taxes"],
            "pva_id" : "GB370241527",
            "ioss_id" : "IM3720000960",
            "voec_id" : "VOEC2036495"
        }
    ]
}
```

## Entity Properties

### Third Party Billing Account Group Properties

<Expandable title="Third Party Billing Account Group Properties">
  <ParamField path="tpb_group_id" type="integer">
    An automatically generated unique identifier for a Third Party Billing Account Group.
  </ParamField>

  <ParamField path="label" type="string">
    A descriptive name to identify a Third Party Billing Account Group.
  </ParamField>

  <ParamField path="status" type="string">
    The status of the group. Possible values: `active`, `inactive`, `pending_approval`
  </ParamField>

  <ParamField path="payment_types" type="array">
    The payment types of the group. Allowed payment types: `shipping`, `duties_and_taxes`
  </ParamField>

  <ParamField path="pva_id" type="string">
    The PVA ID of the group.
  </ParamField>

  <ParamField path="ioss_id" type="string">
    The IOSS ID of the group.
  </ParamField>

  <ParamField path="voec_id" type="string">
    The VOEC ID of the group.
  </ParamField>
</Expandable>