Saltar al contenido principal
POST
Change External Subscription Payment Method
Usa este endpoint con las suscripciones de Stripe Billing para cambiar una suscripción a otro método de pago almacenado del mismo cliente.
No se realiza ningún pagoYuno no cobra al cliente y no ejecuta una verificación de $0 ni 3DS. Yuno establece el nuevo método de pago como el predeterminado de la suscripción en Stripe, y las próximas renovaciones se cobran con él.

Solicitud

El encabezado X-Idempotency-Key es obligatorio. Repetir la misma clave con la misma solicitud devuelve el primer resultado. Enviar el método de pago que la suscripción ya cobra devuelve 200 y no cambia nada. Esta API se habilita por cuenta. Contacta a tu Key Account Manager para solicitar acceso.

Errores

Autorizaciones

public-api-key
string
header
requerido
private-secret-key
string
header
requerido

Encabezados

X-Idempotency-Key
string
requerido

Clave única para este cambio, por ejemplo un UUID. Obligatoria: una solicitud sin ella devuelve 400 INVALID_PARAMETERS. Repetir la misma clave con la misma solicitud devuelve el resultado de la primera solicitud. Reutilizar una clave para otra suscripción u otro método de pago devuelve 400 INVALID_PARAMETERS. Para reintentar después de un 502, envía una clave nueva.

Parámetros de ruta

external_subscription_id
string
requerido

El ID de la suscripción en la plataforma de facturación, por ejemplo el ID de suscripción de Stripe (sub_...). Entre 3 y 255 caracteres.

Required string length: 3 - 255

Cuerpo

application/json
account_id
string<uuid>
requerido

El identificador único (UUID) de la cuenta de Yuno incorporada al billing bridge.

Ejemplo:

"9104911d-5df9-429e-8488-ad41abea1a4b"

customer_payer
object
requerido

El cliente que es dueño de la suscripción y del método de pago.

vaulted_token
string<uuid>
requerido

El token del vault (UUID) de uno de los métodos de pago inscritos del cliente. La suscripción lo cobra a partir de ahora.

Ejemplo:

"2deff5c9-da62-4888-8f05-df76ab2967a5"

Respuesta

La suscripción ahora usa el método de pago de vaulted_token. También se devuelve, sin cambios, cuando ese método de pago es el que la suscripción ya usa.

external_subscription_id
string

El ID de la suscripción en la plataforma de facturación externa.

account_id
string<uuid>

El ID de cuenta de Yuno de la solicitud.

customer_payer
object
vaulted_token
string<uuid>

El token del vault que la suscripción cobra a partir de ahora.