Ir a la documentación
API

Activar o desactivar el pago por uso

El interruptor de Planes y facturación, y la tarjeta que pide la primera vez.

PATCH/billing/pay-as-you-go

Ejecuta cualquiera de las 2 llamadas en tu espacio de trabajo.

PATCH /billing/pay-as-you-go

El interruptor de Planes y facturación, y la tarjeta que pide la primera vez.

Ejemplo

Requiere billing:write. Desactivarlo surte efecto al instante, y el uso se detiene en los cupos. Activarlo surte efecto al instante cuando hay una tarjeta guardada. La primera vez, checkoutUrl es un enlace donde la persona añade una tarjeta, y el pago por uso empieza cuando lo ha hecho. theme y locale dan estilo a la página que abre el enlace.

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
Respuesta
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

Nada se paga mediante la API. El enlace abre la página del proveedor de pagos, donde la persona paga, cambia la tarjeta o cancela, igual que desde la app.

Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.

Después del pago

Requiere billing:write. Cuando la persona ha añadido la tarjeta, POST /billing/pay-as-you-go/confirm lo comprueba con el proveedor de pagos y lo registra, como hace la app cuando vuelve. enabled indica si el pago por uso está activado ahora, y volver a llamarlo es seguro.

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
Respuesta
{ "object": "pay_as_you_go_confirmation", "enabled": true }

activating: true del interruptor significa que se acaba de guardar una tarjeta y que el pago por uso se está activando, así que vuelve a leerlo en un momento.

Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.

Referencia