Skip to main content
POST
Créer un abonnement
Essayez avec une clé sandbox (mp_sandbox_…) : aucun argent réel ne bouge. Voir Test et production.
Envoyez la page next_action.redirect_url à votre client. Il y paie le premier cycle par carte ou mobile money, ou enregistre son moyen de paiement si le plan a un essai encore disponible pour lui. L’abonnement devient active (ou trialing) et vous recevez subscription.created. Sans paiement sous 48 heures, l’inscription est annulée. Voir Paiement récurrent pas à pas.

Authorizations

Authorization
string
header
required

Votre clé API. Utilisez une clé sandbox (mp_sandbox_…) pour essayer : aucun argent réel ne bouge.

Headers

Idempotency-Key
string

Une clé unique par opération : la rejouer pendant 24 heures renvoie la même réponse sans rien créer de plus. Voir Idempotence.

Maximum string length: 255

Body

application/json
customer_name
string
required

Nom du client

Maximum string length: 255
customer_email
string<email>
required

Reçoit les reçus, les rappels et l'accès à l'espace client

Maximum string length: 255
plan
string
required

Identifiant d'un de vos plans actifs (plan_…)

payment_method
enum<string>

Sans ce champ, le client choisit sur la page de paiement

Available options:
card,
mobile_money
customer_phone
string

Numéro mobile money. Avec payment_method: "mobile_money", la première demande part tout de suite sur ce téléphone.

Maximum string length: 32
customer_country
string

Avec customer_phone. Pays ISO 3166-1 alpha-3, par exemple CMR.

customer_provider
string

Avec customer_phone. Code opérateur, par exemple MTN_MOMO_CMR. Voir Pays et opérateurs.

Maximum string length: 64
max_cycles
integer

Nombre d'échéances avant l'arrêt, de 1 à 1000

Required range: 1 <= x <= 1000
metadata
object | null

Vos données libres, renvoyées telles quelles. 50 clés maximum, valeurs de 500 caractères maximum.

Response

Abonnement créé, incomplete jusqu'au premier paiement

data
object