GET/api/v6/urlshortener/pricing

Current pricing

What creating a link and each visit cost your organization, and whether its plan includes it.

Scope

API key with the urlshortener service enabled

Usage limit

60 requests per minute

Returns the prices applied to your organization today: the service’s general ones or the ones agreed for it. Each link creation is charged, and so is every visit by a person that reaches the destination, repeat visits included. Visits from bots and the previews that messaging apps (WhatsApp, Telegram, Facebook, Google Messages and the like) build when someone shares the link are not charged.

Amounts are in micros: currency units multiplied by 10⁶ (1000000 is 1.00). includedInPlan: true means your organization has an active monthly URL shortener plan today: link creation and visits are included. Prices come anyway, so you know what the plan covers; if no price is configured, they come as null.

Responses

200

Current pricing. The amounts in the example are illustrative.

{
  "success": true,
  "data": {
    "currency": "COP",
    "perLinkMicro": 1000000,
    "perUniqueVisitMicro": 500000,
    "includedInPlan": false
  },
  "meta": {
    "requestId": "8f0c0e2a4b1d4c8fae2b7a91e0c5d3f6",
    "timestamp": "2026-09-23T18:30:00+00:00",
    "responseTimeMs": 7.2
  }
}

401

Invalid or missing credentials.

403

The API key does not have the URL shortener enabled (or it is turned off for your organization), the key cannot be used from the request network, or the organization is not active.

429

Request limit exceeded.

409

The URL shortener has no price for your organization’s currency, or your organization does not have a currency yet. It happens with or without a plan, and in that state links cannot be created either. Retrying does not fix it.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

401AUTH_REQUIREDNo Bearer token was sent, and every call requires one.401AUTH_INVALID_KEYThe API key is not recognized: wrong format, revoked or expired.403AUTH_SERVICE_NOT_ALLOWEDThe key is not allowed to use the service behind this endpoint.403AUTH_IP_NOT_ALLOWEDThe key only works from certain networks and your IP is not one of them.403ACCOUNT_NOT_ACTIVEYour organization is suspended or closed.409URLSHORTENER_NOT_PRICEDThe URL shortener has no price configured for your currency.409URLSHORTENER_CURRENCY_UNDEFINEDYour organization does not have a currency yet.429RATE_TPS_EXCEEDEDYou exceeded your organization quota for this endpoint.

See the full catalog

Scope and limits

Responses

Possible errors