Passer au contenu principal
POST
Creer une souscription

Unité du montant

Envoyez amount en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Les clients API qui envoient déjà des centimes peuvent préciser amount_unit: "MINOR" à la racine du corps JSON, au même niveau que amount et currency, et non dans metadata. Les réponses publiques reviennent en valeur réelle même si la requête utilise MINOR. Consultez les montants et devises.

Autorisations

x-sp-auth-token
string
header
requis

Token Bearer obtenu avec le client_id et le client_secret de l'application creee dans SoleasPay. Format: Bearer <access_token>.

En-têtes

X-Idempotency-Key
string

Cle d'idempotence optionnelle fournie par le marchand.

Corps

application/json
customer_email
string<email>
requis
amount
number
requis

Montant en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Avec amount_unit MINOR à la racine, envoyez des centimes entiers (401).

currency
string
requis
Exemple:

"XAF"

frequency
enum<string>
requis
Options disponibles:
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
YEARLY
customer_phone_number
string
description
string
metadata
object
idempotency_key
string
amount_unit
enum<string>
défaut:MAJOR

Unité des montants de la requête. Facultatif, MAJOR par défaut. Placez ce champ à la racine du corps JSON, pas dans metadata. MINOR conserve les montants déjà exprimés dans la plus petite unité.

Options disponibles:
MAJOR,
MINOR
Exemple:

"MAJOR"

Réponse

Souscription retournee

code
integer
Exemple:

200

success
boolean
Exemple:

true

locale
string
Exemple:

"fr"

message
string
meta
object
data
object