API documentation | API docs for agents | OpenAPI 3.1

billing-requirements

ark.set_customer_billing_requirements

Replaces the required billing packet document type list for a visible customer. Send an empty requiredBillingPacketFileTypes array to clear requirements.

Availability: Expanded preview
Scopes: customers:write
ARK permissions: canEditCustomer
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

customerIdpathstringrequired: Visible ARK customer ID.; format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

requiredBillingPacketFileTypesarray<string>required

Exact required billing packet document types for the customer. Send an empty array to clear requirements.

max items: 50

Example request

Shell

curl -X PUT 'https://arktms.com/api/v1/customers/<customerId>/billing-requirements' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "requiredBillingPacketFileTypes": [
    "BOL"
  ]
}'

Success response

Customer billing requirement result

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.customerIdstringrequired

format: uuid

data.requiredBillingPacketFileTypesarray<string>required

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry