L'objet d'abonnement

Attributs

Cet objet représente un abonnement qui peut être associé à un client.

id chaîne
L'identifiant unique de l'abonnement (MAX 64 ; MIN 36).
Exemple: 7304911d-5df9-429e-8488-ad41abea1a4c

name chaîne
Le nom de l'abonnement (MAX 255 ; MIN 3).
Exemple : sub_001

description chaîne
La description de l'abonnement (MAX 255 ; MIN 3).
Exemple : Service de streaming

account_id chaîne
L'identifiant unique du compte qui disposera du plan d'abonnement plan d'abonnement disponible (MAX 64 ; MIN 36).
Example: 2404911d-5df9-429e-8488-ad41abea1a4b

merchant_reference chaîne
Identification du plan d'abonnement (MAX 255 ; MIN 3).
Exemple : 001_marzo_23

country chaîne
Le pays de l'abonnement.
Exemple : LE CO

status enum
Statut de l'abonnement.
Valeurs possibles :

ACTIVE=L'abonnement a été créé avec un client associé et est déjà actif. actif.
PAUSED=L'abonnement a été interrompu et peut être réactivé.
COMPLETED=L'abonnement est terminé car il a atteint la date et l'heure de fin.
CANCELED=Souscription annulée.

amount objet

Spécifie l'objet montant de l'abonnement, avec la valeur et la devise.

currency enum
La devise utilisée pour effectuer le payment (MAX 3 ; MIN 3 ; ISO 4217).
Valeurs possibles : Voir la référence du pays.

value nombre
Le montant du payment (multiple de 0,0001).
Exemple : 12100.00

frequency objet

Fréquence définie pour l'abonnement au paiement.
Si elle n'est pas définie, les valeurs par défaut sont MONTH pour le type et 1 pour la valeur.

type enum
Le type d'intervalle de temps de l'abonnement (JOUR, SEMAINE, MOIS). S'il n'est pas défini, il s'agit toujours d'un mois par défaut.
Valeurs possibles : DAY, MONTHou YEAR.

value int
La valeur entre chaque intervalle que l'abonnement aura dans le temps. S'il n'est pas défini, il est toujours égal à 1 par défaut.
Exemple : 1

billing_cycles objet

Spécifie l'objet billing_cycles.

total nombre
Nombre total de cycles de facturation.
Exemple : 10

current nombre
Valeur du cycle de facturation en cours.
Exemple : 2

next_at Horodatage
La date du prochain paiement pour l'abonnement.
Example: 2023-02-16T20:00:00.786342Z

billing_date objet

[Facultatif] Spécifie l'objet billing_date. S'exclut mutuellement avec l'objet frequency.

type nombre
Le type de date de facturation que l'abonnement aura dans le temps. temps. PRÉPAYÉ, POSTDATÉ, JOUR. Si elle n'est pas définie, la date de création du plan sera définie par défaut.
Exemple : PLAN_CREATION_DATE

day nombre
Le jour du mois où l'abonnement doit être facturé si le type est défini sur DAY. Par défaut, il s'agit toujours de 1.
Exemple : 2

customer_payer objet

Spécifie l'objet client_payeur.

id* chaîne
L'identifiant unique du client (MAX 255 ; MIN 3).
Exemple : 3t04911d-5df9-429e-8488-ad41abea1a2c

payment_method tableau d'objets

Spécifie l'objet de Méthode_de_paiement

type enum
Type de méthode de paiement.
Valeurs possibles de l'enum possibles : CARD

token chaîne
token de paiement à usage unique token par le SDK Yuno (MAX 64 ; MIN 36).
Exemple: 9104911d-5df9-429e-8488-ad41abea1a4b

vaulted_token chaîne
token voûté token mode de paiement enregistré (MAX : 64 ; MIN : 36).
Example: 6104911d-5df9-429e-8488-ad41abea1a4b

card objet

Spécifie l'objet de la carte.

verify booléen
En utilisant amount = 0 et verify = true, vous pouvez vérifier la carte de l'utilisateur sans autoriser un montant réel. la carte de l'utilisateur sans autoriser un montant réel.
Valeurs possibles : ture ou false.

card_data objet

Spécifie l'objet card_data.

number chaîne
Numéro de la carte sans séparateur (MAX 19 ; MIN 8) - disponible uniquement pour les commerçants certifiés PCI.
Exemple : 4507990000000010

expiration_month nombre
Mois d'expiration de la carte - MM (MAX 2 ; MIN 2) - disponible uniquement pour les commerçants certifiés PCI.
Exemple : 10

expiration_year nombre
Année d'expiration de la carte - YYYY (MAX 4 ; MIN 4) - disponible uniquement pour les commerçants certifiés PCI.
Exemple : 2025

security_code nombre
Code de sécurité de la carte (MAX 4 ; MIN 3) - disponible uniquement pour les commerçants certifiés PCI. disponible uniquement pour les commerçants certifiés PCI.
Exemple : 123

holder_name chaîne
Nom complet du titulaire de la carte tel qu'il apparaît sur la carte (MAX 26 ; MIN 3). (MAX 26 ; MIN 3) - disponible uniquement pour les commerçants certifiés PCI.
Exemple : JOHN DOE

trial_period objet

Spécifie l'objet trial_period.

billing_cycles nombre
Nombre total de cycles de facturation auxquels l'essai gratuit doit s'appliquer.
Exemple : 1

amount objet

Montant à escompter pour la période d'essai.

currency chaîne
La devise utilisée pour effectuer la période d'essai. (ISO 4217 MAX 3 ; MIN 3).
Exemple : COP

value nombre
Mois d'expiration de la carte - MM (MAX 2 ; MIN 2) - disponible uniquement pour les commerçants certifiés PCI.
Exemple : 10

availability objet

Spécifie l'objet de disponibilité. Les dates auxquelles l'abonnement sera disponible. Si elle est nulle, la date de début sera le jour de la création et il n'y aura pas de date de fin.

start_at Horodatage
La date à laquelle l'abonnement sera disponible disponible à l'utilisation.
Example: 2024-01-16T00:00:00.786342Z

finish_at Horodatage
La date de fin jusqu'à laquelle l'abonnement sera disponible à l'utilisation.
Example: 2024-05-26T20:00:00.786342Z

retries objet

Spécifie l'objet retries. Si nous devons réessayer les transactions refusées dans Yuno et le montant si nécessaire.

retry_on_decline bool
Si nous devons réessayer un paiement ou non après un premier refus. Faux par défaut.
Exemple : VRAI

amount nombre
Le nombre de tentatives que le plan d'abonnement devra effectuer jusqu'à l'achèvement. S'il n'est pas défini, ou s'il est supérieur à 7, 7 sera défini par défaut. Max : 7
Exemple : 4

initial_payment_validation bool
Indicateur permettant de déterminer si l'abonnement doit attendre le premier paiement pour continuer. Faux par défaut. MIN 27).
Exemple : faux

metadata objet

Spécifie l'objet métadonnées.

key chaîne
Cette valeur sert de nom ou d'identifiant pour les métadonnées. Utilisez un terme descriptif. (MAX 48 ; MIN 1).
Exemple : sub_ext_id

value chaîne
Les informations que vous souhaitez stocker dans les métadonnées. (MAX 512 ; MIN 1).
Exemple : AA001

payments Tableau de chaînes de caractères

Spécifie le tableau des paiements.

id* chaîne
L'identifiant unique du paiement (MAX 64 ; MIN 36).
Exemple : 5104911d-5df9-229e-8468-bd41abea1a4s

created_at Horodatage
Date et heure de création de l'abonnement (ISO 8601 MAX 27 ; MIN 27).
Example: 2023-12-16T20:46:54.786342Z

updated_at Horodatage
Date et heure de la dernière mise à jour de l'abonnement (ISO 8601 MAX 27 ; MIN 27).
Example: 2023-12-16T21:00:54.786342Z

additional_data objet

Spécifie l'objet additional_data. Cet objet n'est pas obligatoire. Cependant, si vous envoyez ces informations, l'expérience de paiement sera améliorée pour votre utilisateur.

order objet

Spécifie l'objet de l'ordre.

items tableau d'objets

Spécifie l'objet de l'élément.

id chaîne
L'identifiant unique de l'élément (MAX 255 ; MIN 3).
Exemple : 3214

name chaîne
Le nom de l'élément (MAX 255 ; MIN 3).
Exemple : iPhone 12 Pro Max

quantity int
La quantité de l'article (MAX 999 ; MIN 1).
Exemple : 1

unit_amount flotteur
Le montant unitaire de l'article (multiple de 0,0001).
Exemple : 550

category chaîne
La catégorie de l'article (MAX 255 ; MIN 3).
Valeurs possibles : Vérifier la liste des catégories d'éléments.

brand chaîne
La marque de l'article (MAX 255 ; MIN 3).
Exemple : Apple

sku_code chaîne
L'unité de gestion des stocks (SKU) de l'article (MAX 255 ; MIN 3).
Exemple : A2342

manufacture_part_number chaîne
Le numéro de la pièce de fabrication de l'article (MAX 255 ; MIN 3).
Exemple : 345621234