---
title: "Update the billing profile"
description: "Changes the legal data invoices carry. A field left out keeps its value.\n\n- **Scope:** `account:billing:write`\n- **Credentials:** an API key, a client-credentials token or a person's access token\n- **Effect:** writes; idempotent, safe to retry\n- **Limits:** request body up to 32 KB, response up to 256 KB\n- **CLI:** `arbol account billing-profiles update` · **MCP tool:** `account_billing_profiles_update`"
---

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

Path: Account API › Billing profiles

`PATCH /v1/account/billing-profiles/{billingProfileId}`

Changes the legal data invoices carry. A field left out keeps its value.

- **Scope:** `account:billing:write`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** writes; idempotent, safe to retry
- **Limits:** request body up to 32 KB, response up to 256 KB
- **CLI:** `arbol account billing-profiles update` · **MCP tool:** `account_billing_profiles_update`

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `account:billing:write`
- `arbolMachine`, oauth2, scopes: `account:billing:write`
- `arbolApiKey`, http, header `Authorization`

## Path parameters

- `billingProfileId` (`account.billingProfiles.update.path.billingProfileId`; string, required) — The billing profile's id: the caller's own organization's id.
  - pattern `^org_[A-Za-z0-9]{16}$`

## Request body

_Required._

- `legalName` (`account.billingProfiles.update.legalName`; string, optional)
  - minLength 1; maxLength 256
- `taxId` (`account.billingProfiles.update.taxId`; string, optional)
  - minLength 1; maxLength 64
- `taxIdType` (`account.billingProfiles.update.taxIdType`; string, optional)
  - minLength 1; maxLength 32
- `email` (`account.billingProfiles.update.email`; string, optional)
  - format `email`; maxLength 320
- `withholdingAgent` (`account.billingProfiles.update.withholdingAgent`; boolean, optional)
- `billingDay` (`account.billingProfiles.update.billingDay`; integer, optional)
  - min 1; max 28

## Example request

```json
{
  "legalName": "string",
  "taxId": "string",
  "taxIdType": "string",
  "email": "user@example.com",
  "withholdingAgent": true,
  "billingDay": 1
}
```

## Code samples

### cURL

```bash
curl "https://api.getarbol.com/v1/account/billing-profiles/<billingProfileId>" \
  --request PATCH \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.account.billingProfiles.update({
  billingProfileId: "<billingProfileId>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .account()
    .billing_profiles()
    .update(&types::AccountBillingProfilesUpdateInput {
        billing_profile_id: "<billingProfileId>".into(),
        legal_name: None,
        tax_id: None,
        tax_id_type: None,
        email: None,
        withholding_agent: None,
        billing_day: None,
    })
    .await?;
```

### CLI

```bash
arbol account billing-profiles update '<billingProfileId>'
```

### MCP

```json
{
  "name": "account_billing_profiles_update",
  "arguments": {
    "billingProfileId": "<billingProfileId>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "legalName": "string",
    "taxId": "string",
    "taxIdType": "string",
    "email": "string",
    "withholdingAgent": true,
    "billingDay": 1,
    "currency": "USD",
    "complete": true
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.200.success`; boolean, required)
  - one of `true`
- `data` (`account.billingProfiles.update.response.200.data`; object, required)
  - `legalName` (`account.billingProfiles.update.response.200.data.legalName`; string | null, required)
    - maxLength 256
  - `taxId` (`account.billingProfiles.update.response.200.data.taxId`; string | null, required)
    - maxLength 64
  - `taxIdType` (`account.billingProfiles.update.response.200.data.taxIdType`; string | null, required)
    - maxLength 32
  - `email` (`account.billingProfiles.update.response.200.data.email`; string | null, required)
    - maxLength 320
  - `withholdingAgent` (`account.billingProfiles.update.response.200.data.withholdingAgent`; boolean, required)
  - `billingDay` (`account.billingProfiles.update.response.200.data.billingDay`; integer, required)
    - min 1; max 28
  - `currency` (`account.billingProfiles.update.response.200.data.currency`; string, required)
    - one of `"USD"`, `"COP"`
  - `complete` (`account.billingProfiles.update.response.200.data.complete`; boolean, required)
- `error` (`account.billingProfiles.update.response.200.error`; unknown, required)
- `metadata` (`account.billingProfiles.update.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

`INVALID_INPUT`: The request does not match the published schema.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.400.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.400.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`account.billingProfiles.update.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`account.billingProfiles.update.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.400.error.data`; object, required)
    - `issues` (`account.billingProfiles.update.response.400.error.data.issues`; array<object>, optional)
      - `path` (`account.billingProfiles.update.response.400.error.data.issues.path`; string, required) — RFC 6901 JSON Pointer to the refused field; empty for the whole input.
        - maxLength 256
      - `message` (`account.billingProfiles.update.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`account.billingProfiles.update.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.401.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.401.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.401.error`; object, required) — A valid access token is required.
  - `code` (`account.billingProfiles.update.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`account.billingProfiles.update.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.401.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

`FORBIDDEN`: The token does not authorize this operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.403.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.403.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`account.billingProfiles.update.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`account.billingProfiles.update.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.403.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`BILLING_RECORD_NOT_FOUND`: Billing has no such record.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "BILLING_RECORD_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.404.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.404.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.404.error`; object, required) — Billing has no such record.
  - `code` (`account.billingProfiles.update.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"BILLING_RECORD_NOT_FOUND"`
  - `message` (`account.billingProfiles.update.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.404.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

`BILLING_REJECTED`: Billing refused the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "BILLING_REJECTED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.409.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.409.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.409.error`; object, required) — Billing refused the request.
  - `code` (`account.billingProfiles.update.response.409.error.code`; string, required) — The failure code, stable across releases.
    - one of `"BILLING_REJECTED"`
  - `message` (`account.billingProfiles.update.response.409.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.409.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.409.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.413.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.413.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`account.billingProfiles.update.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`account.billingProfiles.update.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.413.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 415

`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.415.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.415.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`account.billingProfiles.update.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`account.billingProfiles.update.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.415.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

`RATE_LIMITED`: The request rate limit was exceeded. Try again later.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.429.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.429.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`account.billingProfiles.update.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`account.billingProfiles.update.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`account.billingProfiles.update.response.429.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.500.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.500.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`account.billingProfiles.update.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`account.billingProfiles.update.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.500.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

`OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.502.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.502.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.502.error`; object, required) — The operation may have been applied; check its result before repeating it.
  - `code` (`account.billingProfiles.update.response.502.error.code`; string, required) — The failure code, stable across releases.
    - one of `"OUTCOME_UNKNOWN"`
  - `message` (`account.billingProfiles.update.response.502.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.502.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.billingProfiles.update.response.502.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

- `UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.
- `BILLING_UNAVAILABLE`: Billing did not answer.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.503.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.503.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.503.error`; one of, required)
  - one of: `UpstreamUnavailableFailure`, `AccountBillingUnavailableFailure`
  - discriminator: `code`
- `metadata` (`account.billingProfiles.update.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.billingProfiles.update.response.504.success`; boolean, required)
  - one of `false`
- `data` (`account.billingProfiles.update.response.504.data`; unknown, required)
- `error` (`account.billingProfiles.update.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`account.billingProfiles.update.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`account.billingProfiles.update.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.billingProfiles.update.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`account.billingProfiles.update.response.504.error.data`; object, required) — No fields.
- `metadata` (`account.billingProfiles.update.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.billingProfiles.update.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/account/billing-profiles/update/index.md