Skip to main content
POST
/
packages
/
{id}
/
recharge-label
Charge customer (or absorb) the cost delta after a re-rate
curl --request POST \
  --url https://api.arcuserp.com/v1/packages/{id}/recharge-label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "recharge",
  "payment_method_id": "pm_1AbcD2eF3G4HiJkL5mNoPqR6",
  "notes": "Customer requested overnight upgrade for birthday delivery"
}
'
{
  "data": {
    "delta": 123,
    "action": "recharge",
    "shipping_total_updated": true,
    "gl_je_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "charge_status": "charged",
    "charge_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "idempotent": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
action
enum<string>
required

What to do with the cost delta. recharge bills the customer (requires payment_method_id for in-API Stripe charge). absorb logs but does not move money. manual flags for offline handling.

Available options:
recharge,
absorb,
manual
​
label_id
string<uuid>

Optional explicit label id. When omitted, the active (non-voided) label on the package is used.

​
payment_method_id
string

Saved Stripe payment method to charge for the delta. Only honored when action='recharge' and the carrier cost exceeds what the customer was charged. Soft-fails on decline.

​
update_order_total
boolean
default:true

When true (default) and action='recharge', updates orders.shipping_total to match the new carrier cost and re-flows totals via recalculateOrderTotals.

​
notes
string

Optional human note recorded on the activity log entry and (for the recharge branch) on the Stripe charge description.

Response

Delta processed

​
data
object