Name
URL Shortener pricing
What creating a link and each visit cost your organization, and whether its plan includes it.
HTTP method and path
/https:
What happens when you run it
- Read only: it does not change your organization’s data.
- The call is not charged.
What it does
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: 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.
Availability and prerequisites
- Published and available in the production API v6.
- Every path starts at
https:./ / developers. hablame. co - You need a Hablame API key to call it.
Authentication and permissions
- Send your API key in the
Authorizationheader with the Bearer scheme.
Who can call it: An API key with the urlshortener service enabled.
Limits and operational notes
Usage limit: 60 requests per minute.
Path parameters
This endpoint has no path parameters.
Query parameters
This endpoint has no query parameters.
HTTP headers
| Name | Type | Description and rules |
|---|---|---|
AuthorizationRequired | string | Your API key with the Bearer scheme. Example: |
Request body
This endpoint takes no request body.
Successful responses
200
Current pricing. The amounts in the example are illustrative.
{
"success": true,
"data": {
"currency": "COP",
"perLinkMicro": 1000000,
"perUniqueVisitMicro": 500000,
"includedInPlan": false
},
"meta": {
"requestId": "8f0c0e2a4b1d4c8f",
"clientIp": "203.0.113.45",
"timestamp": "2026-09-23T18:30:00+00:00",
"responseTimeMs": 7.2
}
}The example values are illustrative.
Response fields
| Name | Type | Description and rules |
|---|---|---|
successAlways present | boolean | |
dataAlways present | object | |
data.Always present | string | Your organization’s currency (ISO 4217). Example: |
data.Always present | integer | Price per created link, in micros. May come as |
data.Always present | integer | Price per visit, in micros. The name dates from when only the first visit of the day was charged; today every visit by a person is charged. May come as |
data.Always present | boolean |
|
metaAlways present | object | Response metadata. |
meta.Always present | string | Unique request identifier (16 hexadecimal characters). It matches the Example: |
meta.Always present | string | IP the API saw your request come from. Useful if your API key only accepts certain networks. Example: |
meta.Always present | string | Date and time the response was built (ISO 8601 with offset). Format: |
meta.Always present | number | Time (ms) the server took to process the request. Example: |
Error codes
Every error response has the same shape: success set to false and an error object whose code says what happened. They are grouped here by kind, with the codes this endpoint can return.
Shape of an error response
| Name | Type | Description and rules |
|---|---|---|
successAlways present | boolean | Fixed value: |
metaAlways present | object | Response metadata. |
meta.Always present | string | Unique request identifier (16 hexadecimal characters). It matches the Example: |
meta.Always present | string | IP the API saw your request come from. Useful if your API key only accepts certain networks. Example: |
meta.Always present | string | Date and time the response was built (ISO 8601 with offset). Format: |
meta.Always present | number | Time (ms) the server took to process the request. Example: |
errorAlways present | object | |
error.Always present | string | Stable UPPER_SNAKE_CASE identifier. Clients branch on this value. Example: |
error. | integer | Legacy v5 numeric code, only when a bridge exists. Omitted for codes born in v6. Example: |
error.Always present | string | URL to the error documentation. Format: |
error.Always present | string | Human readable text, in English. It is for the developer log, not the end user: do not parse it. |
error.Always present | array<object> | Structured context (validation issues, affected resource). Empty array when there is no extra context. |
Validation
This endpoint does not declare responses of this kind.
Authentication
- 401Invalid or missing credentials.
No Bearer token was sent, and every call requires one.
Message the API returns: Authentication is required. Send your API key as `Authorization: Bearer <token>`.
The API key is not recognized: wrong format, revoked or expired.
Message the API returns: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.
Permissions
- 403The 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.
The key is not allowed to use the service behind this endpoint.
Message the API returns: This API key is not authorized to use the requested service.
The key only works from certain networks and your IP is not one of them.
Message the API returns: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.
Your organization is suspended or closed.
Message the API returns: The organization associated with this API key is not active. Please contact support.
Usage limits
- 429Request limit exceeded.
You exceeded your organization quota for this endpoint.
Message the API returns: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.
Resource not found
This endpoint does not declare responses of this kind.
Internal errors and availability
This endpoint does not declare responses of this kind.
Other responses
- 409The 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.
The URL shortener has no price configured for your currency.
409URLSHORTENER_CURRENCY_UNDEFINED
Your organization does not have a currency yet.
Special considerations
This endpoint has no special considerations.