Horloges de test

Guide : Tester.

URL de base

https://buy.api.yabetoopay.com/v1/test-helpers   # clé sk_test_ uniquement

Ces routes n’existent qu’en mode test : une clé sk_live_ reçoit 403 { "error": "Test clocks are not available in live mode", "code": "TEST_CLOCK_NOT_AVAILABLE" }.

L’objet `test_clock`

string

Identifiant, préfixé clock_.

string

Votre compte.

string | null

Libellé libre.

string

L’instant courant de l’horloge (ISO 8601).

string

ready, advancing, completed.

array

Sur la liste : les objets rattachés.

string

Créer une horloge

POST /v1/test-helpers/test-clocks

Paramètre	Type	Obligatoire	Description
`frozenTime`	`string` (date)	Oui	L’instant de départ.
`name`	`string`	Non	≤ 255 caractères.

Renvoie 201 et l’objet.

Lister · Lire · Supprimer

GET    /v1/test-helpers/test-clocks
GET    /v1/test-helpers/test-clocks/{id}
DELETE /v1/test-helpers/test-clocks/{id}

La suppression détache les abonnements et clients rattachés, qui reviennent à l’heure réelle.

Rattacher

POST /v1/test-helpers/test-clocks/{id}/attach

Paramètre	Type	Description
`subscriptionId`	`string`	Un abonnement de test de votre compte.
`customerId`	`string`	Un client de votre compte, et tous ses abonnements de test.

Au moins l’un des deux. Renvoie 200 { testClock, attached: [{ type, id }] }.

Avancer

POST /v1/test-helpers/test-clocks/{id}/advance

Paramètre	Type	Obligatoire	Description
`frozenTime`	`string` (date)	Oui	Strictement postérieur à l’instant courant (`400` sinon).

Rejoue, pour chaque abonnement rattaché, tout ce que le temps réel aurait déclenché entre les deux instants : fin d’essai, rappel J-3 (facture émise et envoyée), échéance (billing.due, qui facture et demande le paiement), annulation programmée.

200

{
  "testClock": { "id": "clock_...", "frozenTime": "2026-10-18T10:00:00.000Z", "status": "ready" },
  "triggeredEvents": [{ "event": "subscription/billing.due", "subscriptionId": "sub_..." }],
  "advancedFrom": "2026-09-17T10:00:00.000Z",
  "advancedTo": "2026-10-18T10:00:00.000Z"
}

Les traitements déclenchés sont asynchrones : leur issue se lit sur l’abonnement, ses factures et vos webhooks.

Simuler en un appel

POST /v1/test-helpers/test-clocks/simulate

Paramètre	Type	Obligatoire	Description
`subscriptionId`	`string`	Oui
`advanceTo`	`string` (date)	Oui	Postérieur à `startFrom`.
`startFrom`	`string` (date)	Non	Défaut : `currentPeriodStart` de l’abonnement.
`name`	`string`	Non

Crée l’horloge, rattache l’abonnement, avance. Même réponse que advance.

Erreurs

Corps { "error": "…", "code": "…" }.

Statut	Code	Cause
`403`	`TEST_CLOCK_NOT_AVAILABLE`	Clé live.
`400`	`TEST_CLOCK_COMPLETED`	Horloge terminée.
`400`	—	`frozenTime` non postérieur ; `advanceTo` non postérieur à `startFrom`.
`404`	`TEST_CLOCK_NOT_FOUND`, `SUBSCRIPTION_NOT_FOUND`, `CUSTOMER_NOT_FOUND`	Inconnu, ou pas à vous — même réponse.

Documentation API

Session de paiement

Intention de paiement

Décaissement

Transfert

Lien de paiement

Abonnements

Connect

Webhook

URL de base

L’objet `test_clock`

Créer une horloge

Lister · Lire · Supprimer

Rattacher

Avancer

Simuler en un appel

Erreurs

​URL de base

​L’objet test_clock

​Créer une horloge

​Lister · Lire · Supprimer

​Rattacher

​Avancer

​Simuler en un appel

​Erreurs

URL de base

L’objet `test_clock`

Créer une horloge

Lister · Lire · Supprimer

Rattacher

Avancer

Simuler en un appel

Erreurs