Facturación

Un saldo prepago: las cuentas conectadas a partir de las gratis se cobran día a día y el uso (API de X, mensajes) según se produce. Se recarga desde el panel.

Ver el saldo

GET/v1/billing

Saldo, cuentas conectadas y lo que cuestan. Con el saldo agotado, conectar más allá de las cuentas gratis, y publicar o enviar desde las cuentas a partir de ellas o de X, responden 402.

Respuesta 200

data

enabledbooleanobligatorio
False mientras la facturación no está disponible: no se cobra ni se limita nada.
balancenumberobligatorio
Saldo prepago en céntimos (hasta tres decimales). Negativo si los cargos lo superaron.
currencystringobligatorio
connectedAccountsintegerobligatorio
máx. 9.007.199.254.740.991
freeAccountsintegerobligatorio
máx. 9.007.199.254.740.991
monthlyEstimateintegerobligatorio
Precio mensual de las cuentas conectadas ahora, en céntimos. Se cobra día a día.
máx. 9.007.199.254.740.991
dailyEstimatenumberobligatorio
Lo que cuestan hoy esas cuentas, en céntimos (hasta tres decimales).
daysLeftinteger | nullobligatorio
Días completos que cubre el saldo a ese coste; null si no hay cargo diario.
linesobject[]obligatorio
lines
- fromintegerobligatorio
  máx. 9.007.199.254.740.991
- tointeger | nullobligatorio
- accountsintegerobligatorio
  máx. 9.007.199.254.740.991
- unitAmountintegerobligatorio
  Céntimos por cuenta y mes.
  máx. 9.007.199.254.740.991
- amountintegerobligatorio
  máx. 9.007.199.254.740.991
canConnectMorebooleanobligatorio
Si ahora mismo se puede conectar una cuenta más.
blockedbooleanobligatorio
El saldo se ha agotado: las cuentas a partir de las gratis, y las de X, no pueden publicar ni enviar hasta que se recargue.
cardobject
El método de pago guardado, para las recargas automáticas.
card
- brandstringobligatorio
  Marca de la tarjeta (visa, mastercard…) u otro método guardado (link, sepa_debit).
- last4string
- expMonthinteger
  máx. 9.007.199.254.740.991
- expYearinteger
  máx. 9.007.199.254.740.991
autoRechargeobject
autoRecharge
- enabledbooleanobligatorio
- thresholdintegerobligatorio
  Recargar cuando el saldo baje de esto, en céntimos.
  máx. 9.007.199.254.740.991
- amountintegerobligatorio
  Lo que añade cada recarga, en céntimos.
  máx. 9.007.199.254.740.991
- monthlyLimitintegerobligatorio
  Máximo que añaden las recargas automáticas en un mes natural, en céntimos.
  máx. 9.007.199.254.740.991
autoRechargeErrorobject
Por qué falló la última recarga automática; se desactivó sola.
autoRechargeError
- atstring (date-time)obligatorio
- messagestringobligatorio
autoRechargedThisMonthintegerobligatorio
Lo añadido por recargas automáticas este mes, en céntimos.
máx. 9.007.199.254.740.991
topUpobjectobligatorio
Importes de recarga permitidos, en céntimos.
topUp
- minintegerobligatorio
  máx. 9.007.199.254.740.991
- maxintegerobligatorio
  máx. 9.007.199.254.740.991
hasPortalbooleanobligatorio
Si el portal de facturación (facturas, método de pago) está disponible.

curl "https://api.usecrier.com/v1/billing" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/billing', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/billing",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Listar los movimientos del saldo

GET/v1/billing/movements

Recargas y cargos, del más reciente al más antiguo.

Parámetros

limitinteger
máx. 200

Respuesta 200

data []

idstringobligatorio
kindstringobligatorio
Valores: top_up · auto_recharge · accounts · usage · adjustment
amountnumberobligatorio
Céntimos (hasta tres decimales): en positivo suma, en negativo descuenta.
atstring (date-time)obligatorio
daystring
Día UTC (YYYY-MM-DD) que cubre un cargo.
accountsinteger
Cuentas por las que se cobró un día.
máx. 9.007.199.254.740.991
familystring
Tipo de uso de un cargo por uso.
Valores: xApi · messages

curl "https://api.usecrier.com/v1/billing/movements" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/billing/movements', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/billing/movements",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Añadir saldo

POST/v1/billing/top-upSolo desde el panel

Abre una página de pago. El saldo sube cuando el pago se completa, y la tarjeta queda guardada para las recargas automáticas.

Cuerpo

amountintegerobligatorio
Saldo que añadir, en céntimos (impuestos aparte, si los hay). Los límites vienen en GET /v1/billing.
máx. 9.007.199.254.740.991
successUrlstring (uri)obligatorio
Página del panel a la que volver tras pagar.
cancelUrlstring (uri)obligatorio
Página del panel a la que volver si el usuario sale de Checkout.

Respuesta 200

data

urlstring (uri)obligatorio
Manda aquí al usuario.

curl -X POST "https://api.usecrier.com/v1/billing/top-up" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/billing/top-up', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/billing/top-up",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Configurar la recarga automática

PUT/v1/billing/auto-rechargeSolo desde el panel

Recarga la tarjeta guardada cuando el saldo baja del umbral, hasta un máximo al mes. Necesita una recarga previa.

Cuerpo

enabledbooleanobligatorio
thresholdintegerobligatorio
Recargar cuando el saldo baje de esto, en céntimos.
máx. 9.007.199.254.740.991
amountintegerobligatorio
Lo que añade cada recarga, en céntimos.
máx. 9.007.199.254.740.991
monthlyLimitintegerobligatorio
Máximo que pueden añadir las recargas automáticas en un mes natural, en céntimos.
máx. 9.007.199.254.740.991

Respuesta 200

data

enabledbooleanobligatorio
False mientras la facturación no está disponible: no se cobra ni se limita nada.
balancenumberobligatorio
Saldo prepago en céntimos (hasta tres decimales). Negativo si los cargos lo superaron.
currencystringobligatorio
connectedAccountsintegerobligatorio
máx. 9.007.199.254.740.991
freeAccountsintegerobligatorio
máx. 9.007.199.254.740.991
monthlyEstimateintegerobligatorio
Precio mensual de las cuentas conectadas ahora, en céntimos. Se cobra día a día.
máx. 9.007.199.254.740.991
dailyEstimatenumberobligatorio
Lo que cuestan hoy esas cuentas, en céntimos (hasta tres decimales).
daysLeftinteger | nullobligatorio
Días completos que cubre el saldo a ese coste; null si no hay cargo diario.
linesobject[]obligatorio
lines
- fromintegerobligatorio
  máx. 9.007.199.254.740.991
- tointeger | nullobligatorio
- accountsintegerobligatorio
  máx. 9.007.199.254.740.991
- unitAmountintegerobligatorio
  Céntimos por cuenta y mes.
  máx. 9.007.199.254.740.991
- amountintegerobligatorio
  máx. 9.007.199.254.740.991
canConnectMorebooleanobligatorio
Si ahora mismo se puede conectar una cuenta más.
blockedbooleanobligatorio
El saldo se ha agotado: las cuentas a partir de las gratis, y las de X, no pueden publicar ni enviar hasta que se recargue.
cardobject
El método de pago guardado, para las recargas automáticas.
card
- brandstringobligatorio
  Marca de la tarjeta (visa, mastercard…) u otro método guardado (link, sepa_debit).
- last4string
- expMonthinteger
  máx. 9.007.199.254.740.991
- expYearinteger
  máx. 9.007.199.254.740.991
autoRechargeobject
autoRecharge
- enabledbooleanobligatorio
- thresholdintegerobligatorio
  Recargar cuando el saldo baje de esto, en céntimos.
  máx. 9.007.199.254.740.991
- amountintegerobligatorio
  Lo que añade cada recarga, en céntimos.
  máx. 9.007.199.254.740.991
- monthlyLimitintegerobligatorio
  Máximo que añaden las recargas automáticas en un mes natural, en céntimos.
  máx. 9.007.199.254.740.991
autoRechargeErrorobject
Por qué falló la última recarga automática; se desactivó sola.
autoRechargeError
- atstring (date-time)obligatorio
- messagestringobligatorio
autoRechargedThisMonthintegerobligatorio
Lo añadido por recargas automáticas este mes, en céntimos.
máx. 9.007.199.254.740.991
topUpobjectobligatorio
Importes de recarga permitidos, en céntimos.
topUp
- minintegerobligatorio
  máx. 9.007.199.254.740.991
- maxintegerobligatorio
  máx. 9.007.199.254.740.991
hasPortalbooleanobligatorio
Si el portal de facturación (facturas, método de pago) está disponible.

curl -X PUT "https://api.usecrier.com/v1/billing/auto-recharge" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/billing/auto-recharge', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.put(
    "https://api.usecrier.com/v1/billing/auto-recharge",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Abrir el portal de facturación

POST/v1/billing/portalSolo desde el panel

Facturas y método de pago guardado.

Cuerpo

returnUrlstring (uri)obligatorio
Página del panel a la que volver.

Respuesta 200

data

urlstring (uri)obligatorio
Manda aquí al usuario.

curl -X POST "https://api.usecrier.com/v1/billing/portal" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/billing/portal', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/billing/portal",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]