Skip to main content
POST
Créer un plan
Essayez avec une clé sandbox (mp_sandbox_…) : aucun argent réel ne bouge. Voir Test et production.
Le même plan sert un client carte et un client mobile money : ce choix se fait pour chaque abonnement.

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
name
string
required

Nom affiché au client

Maximum string length: 255
amount
integer
required

Prix d'un cycle, en unités mineures

Required range: 1 <= x <= 1000000000
currency
string
required

Code devise ISO 4217 de 3 lettres, par exemple XAF.

Required string length: 3
interval
enum<string>
required

Rythme

Available options:
daily,
weekly,
monthly,
yearly
interval_count
integer
default:1

De 1 à 365, 1 par défaut. monthly et 3 : tous les 3 mois.

Required range: 1 <= x <= 365
trial_period_days
integer
default:0

Jours d'essai, de 0 à 365

Required range: 0 <= x <= 365
description
string

Description

Maximum string length: 500
portal_switchable
boolean
default:false

Proposé aux abonnés dans leur espace client

metadata
object | null

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

Response

Plan créé

data
object