> ## 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.

# Charge customer (or absorb) the cost delta after a re-rate

> <Note>Required API key scope: `fulfillment:write`</Note>

NEW-GAP-RERATE-SHIPPING-CHARGE-DELTA-WORKFLOW (2026-05-16). Reuben verbatim:
"customer pays overnight". Use case: customer originally chose Ground
($12 carrier cost). Now they want Overnight ($45). After the operator
re-rates and buys a new label, this endpoint settles the cost delta.

Three actions on the package's active (non-voided) label:

- `recharge` -- update `orders.shipping_total` to the new carrier cost,
  post a GL revenue delta (DR AR / CR shipping_income for delta_amount),
  optionally charge the customer's saved Stripe card via `payment_method_id`.
- `absorb` -- log the absorbed cost; leave `orders.shipping_total` and GL unchanged.
- `manual` -- flag for offline handling; no GL/total change.

Idempotent: one `shipping_delta` JE per label, ever. Re-calling with the
same `label_id` returns `{ idempotent: true }` with no side effects.

Soft-fail on Stripe decline: when `payment_method_id` is supplied and the
card declines, the GL delta and `shipping_total` update have already
committed; the response carries `charge_status: 'declined'` so the caller
can offer the customer a hosted-checkout payment link.

Delegates to canonical helper `createShippingDeltaCharge` in
`arcus-api-core/utils/shipping-recharge-helpers.mjs`.




## OpenAPI

````yaml /openapi.yaml post /packages/{id}/recharge-label
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /packages/{id}/recharge-label:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Fulfillment
      summary: Charge customer (or absorb) the cost delta after a re-rate
      description: >
        <Note>Required API key scope: `fulfillment:write`</Note>


        NEW-GAP-RERATE-SHIPPING-CHARGE-DELTA-WORKFLOW (2026-05-16). Reuben
        verbatim:

        "customer pays overnight". Use case: customer originally chose Ground

        ($12 carrier cost). Now they want Overnight ($45). After the operator

        re-rates and buys a new label, this endpoint settles the cost delta.


        Three actions on the package's active (non-voided) label:


        - `recharge` -- update `orders.shipping_total` to the new carrier cost,
          post a GL revenue delta (DR AR / CR shipping_income for delta_amount),
          optionally charge the customer's saved Stripe card via `payment_method_id`.
        - `absorb` -- log the absorbed cost; leave `orders.shipping_total` and
        GL unchanged.

        - `manual` -- flag for offline handling; no GL/total change.


        Idempotent: one `shipping_delta` JE per label, ever. Re-calling with the

        same `label_id` returns `{ idempotent: true }` with no side effects.


        Soft-fail on Stripe decline: when `payment_method_id` is supplied and
        the

        card declines, the GL delta and `shipping_total` update have already

        committed; the response carries `charge_status: 'declined'` so the
        caller

        can offer the customer a hosted-checkout payment link.


        Delegates to canonical helper `createShippingDeltaCharge` in

        `arcus-api-core/utils/shipping-recharge-helpers.mjs`.
      operationId: rechargePackageLabel
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action
              properties:
                action:
                  type: string
                  enum:
                    - recharge
                    - absorb
                    - manual
                  description: |
                    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.
                label_id:
                  type: string
                  format: uuid
                  description: |
                    Optional explicit label id. When omitted, the active
                    (non-voided) label on the package is used.
                payment_method_id:
                  type: string
                  description: |
                    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:
                  type: boolean
                  default: true
                  description: |
                    When true (default) and `action='recharge'`, updates
                    `orders.shipping_total` to match the new carrier cost
                    and re-flows totals via `recalculateOrderTotals`.
                notes:
                  type: string
                  description: |
                    Optional human note recorded on the activity log entry
                    and (for the recharge branch) on the Stripe charge
                    description.
            example:
              action: recharge
              payment_method_id: pm_1AbcD2eF3G4HiJkL5mNoPqR6
              notes: Customer requested overnight upgrade for birthday delivery
      responses:
        '200':
          description: Delta processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      delta:
                        type: number
                        description: >-
                          Carrier cost minus customer-charged (positive =
                          upgrade, negative = overpay)
                      action:
                        type: string
                        enum:
                          - recharge
                          - absorb
                          - manual
                      shipping_total_updated:
                        type: boolean
                      gl_je_id:
                        type: string
                        format: uuid
                        nullable: true
                        description: id of the shipping_delta journal entry, when posted
                      charge_status:
                        type: string
                        enum:
                          - charged
                          - declined
                          - skipped
                          - no_payment_method
                      charge_payment_id:
                        type: string
                        format: uuid
                        nullable: true
                      order_id:
                        type: string
                        format: uuid
                      label_id:
                        type: string
                        format: uuid
                      idempotent:
                        type: boolean
                        description: true when a previous call already processed this label
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          description: No active label found on this package (purchase one first)
        '422':
          description: Cannot recharge against a voided label
      security:
        - ApiKeyAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: |
        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.
      schema:
        type: string
        maxLength: 255
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        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_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````