API documentation | API docs for agents | OpenAPI 3.1

preparation

ark.prepare_billing_email_retry

Prepare Billing Email Retry through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: loads:readbilling:read
ARK permissions: canViewLoadscanViewBilling
Team visibility: Required and enforced
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

None.

Request body

deliveryIdstringrequired

format: uuid

attemptVersionintegerrequired

max: 9007199254740991

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/delivery-retries/preparation' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "deliveryId": "<deliveryId>",
  "attemptVersion": 1
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.preparationobjectrequired

Exact failed-delivery version, recipient decision, message, and affected obligations.

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