Account

The contract behind your credentials: who you are, your credit, your limits and the functions enabled for you.

GET/account

Get account and key information

Coming soon The contract is published ahead of the implementation. This operation is not available yet and its shape may still change.

Returns the contract the API key belongs to: validity, limits, remaining prepaid credit, test or live mode, and the reserved features enabled for you. The API key itself is never returned (only its last four characters).

Authentication: your API key in the X-API-Key header.

Responses

  • 200Account information.Account
  • 401Missing, invalid or expired API key. Codes: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED.Error
  • 403Authenticated but not allowed. Codes: FEATURE_NOT_ENABLED (reserved feature not enabled for the customer), IP_NOT_ALLOWED (the key is restricted to other addresses), ACCOUNT_INACTIVE, CUSTOMER_OUT_OF_SCOPE.Error
  • 410Version retired. Code VERSION_RETIRED.Error
  • 429Daily or burst limit exceeded. Code DAILY_LIMIT_EXCEEDED or RATE_LIMIT_EXCEEDED. Wait Retry-After seconds.Error
  • 500Unexpected error. Code SERVER_ERROR; details.correlation_id repeats the correlation id.Error
  • 502The carrier or an internal dependency failed. Code UPSTREAM_ERROR. Safe to retry reads; retry writes with the same Idempotency-Key.Error

Request

GET
/account
Loading...

Response 200

{
  "client_name": "Example S.r.l.",
  "api_key_last4": "9f3a",
  "activated_on": "2026-01-01",
  "expires_on": "2026-12-31",
  "allowed_ips": null,
  "daily_call_limit": null,
  "fast_quote": false,
  "prepaid_credit": {
    "amount": "125.00",
    "currency": "EUR"
  },
  "livemode": true,
  "notify_sender_by_email": true,
  "waybill_webhook_url": null,
  "features": [
    "order-direct"
  ]
}

Models

Objects used by the requests and responses on this page.

ParceLabsVersion

CorrelationId

KeyLocale

Account

  • Name
    client_name
    Type
    string
    required
    Italian alias: cliente
    Description

    Customer the API key belongs to.

  • Name
    api_key_last4
    Type
    string
    Italian alias: chiave_ultime4
    Description

    Last four characters of the API key. The full key is never returned.

  • Name
    activated_on
    Type
    string (date)
    Italian alias: attivazione
    Description

    Contract activation date.

  • Name
    expires_on
    Type
    string (date)
    Italian alias: scadenza
    Description

    Contract expiry date.

  • Name
    allowed_ips
    Type
    array of string · nullable
    Italian alias: ip_access
    Description

    IP addresses allowed to call the API with this key. null means no restriction.

  • Name
    daily_call_limit
    Type
    integer · nullable
    Italian alias: limite_giornaliero
    Description

    Daily limit on quotation calls. null means unlimited.

  • Name
    fast_quote
    Type
    boolean
    Italian alias: fast_quote
    Description

    Fast quotation enabled.

  • Name
    prepaid_credit
    Type
    Money
    required
    Italian alias: credito_prepagato
    Description

    Remaining prepaid credit used by shipment purchases.

  • Name
    livemode
    Type
    boolean
    required
    Italian alias: live
    Description

    false: shipment purchases are simulated and charge no credit.

  • Name
    notify_sender_by_email
    Type
    boolean
    Italian alias: email_ordine_mittente
    Description

    Send the order confirmation email to the sender.

  • Name
    waybill_webhook_url
    Type
    string (uri) · nullable
    Italian alias: ldv_api
    Description

    Your endpoint that receives the shipment.waybill_ready webhook.

  • Name
    features
    Type
    array of string
    Italian alias: funzionalita
    Description

    Features enabled for this customer. Operations marked x-visibility: enabled-customers need the matching feature; customer-network gates the reseller functions (customers, credit transfers, balances) whose pages are public. The Order-Faster (S)FTP files belong to order-faster.

Money

An amount of money. Responses always use this object; requests send a plain number (see MoneyAmount).

  • Name
    amount
    Type
    string
    required
    Italian alias: importo
    Description

    Decimal amount as a string with exactly two decimals. Never a float.

  • Name
    currency
    Type
    string
    required
    Italian alias: valuta
    Description

    ISO 4217 currency. v1 is EUR only.

    Allowed values: EUR.

Unauthorized

Forbidden

Gone

TooManyRequests

ServerError

BadGateway

Was this page helpful?