Format des données

Dates

Toutes les dates sont fournies sous forme de timestamp POSIX, représentant le nombre de secondes écoulées depuis Epoch.

Montants

Tous les montants monétaires sont des entiers en centimes d'euro.

Listes

Les listes d'objets ont toutes le même format : un dictionnaire avec deux champs. Le champ data est la liste des objets (par exemple un liste d'objets Payment). Le champ has_more est un booléen indiquant s'il y a d'autres objets dans la page suivante de résultats.

La liste d'objets retournée est triée par ordre chronologique inversé (objets les plus récents retournés en premier). Les identifiants sont ordonnés dans le même sens que les dates de création, ce qui permet de les utiliser pour la pagination (voir paramètre starting_after plus bas) : si l'objet a a été créé après l'objet b, alors a.id > b.id dans l'ordre lexicographique.

Les requêtes de listes d'objets passent leurs paramètres dans la querystring. Les paramètres suivants peuvent être passés pour tous les types d'objets :

• limit (optionnel, défaut à 20, maximum 100) : nombre d'objets à retourner par page de résultats
• starting_after (optionnel) : identifiant minimum (au sens de l'ordre lexicographique) de la liste d'objets à retourner. Une fois récupérée la première page de résultats, la prochaine est récupérable en donnant à ce paramètre la valeur data[data.length - 1].id

{
    "data": [
        {"id": "object_1"},
        {"id": "object_2"},
    ],
    "has_more": true
}

Énumérations

Certains paramètres sont des énumérations et ne peuvent recevoir que des éléments de l'énumération, séparés par des virgules.
Par exemple pour un objet avec un champ de type enum pouvant prendre les valeurs val1, val2 et val3, la querystring enum=val1,val3 permettra de ne retourner que les éléments dont le champ enum est égal à val1 et val3.

Il est aussi possible d'exclure certaines valeurs en les préfixant par __not__, par exemple enum=__not__val2 renverra les mêmes résultats que la querystring plus haut.