> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mercy-pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Créer un plan

> Le prix et le rythme d'un abonnement. Le même plan sert les clients carte et mobile money.

> [!TIP]
>
> Essayez avec une clé **sandbox** (`mp_sandbox_…`) : aucun argent réel ne bouge. Voir [Test et production](https://docs.mercy-pay.com/start/environments.md).

Le même plan sert un client carte et un client mobile money : ce choix se fait pour chaque abonnement.


## OpenAPI

````yaml POST /api/v1/plans
openapi: 3.1.0
info:
  title: API Mercy Pay
  version: 1.0.0
  description: >-
    Encaissez par mobile money et par carte, facturez en récurrent et versez vos
    fonds. Les montants sont des entiers en unités mineures. Chaque réponse
    porte un en-tête `Request-Id`.
servers:
  - url: https://mercy-pay.com
    description: >-
      Production. La clé choisit l'environnement : `mp_sandbox_…` ou
      `mp_live_…`.
security:
  - bearerAuth: []
tags:
  - name: Compte
  - name: Sessions de paiement
  - name: Paiements
  - name: Remboursements
    description: Rendre un paiement au client, en entier.
  - name: Liens de paiement
  - name: Plans
  - name: Abonnements
  - name: Clients
  - name: Factures
  - name: Espace client
  - name: Soldes
  - name: Retraits
  - name: État des opérateurs
  - name: Événements
    description: Tout ce qui s'est passé sur le compte, envoyé ou non à un endpoint.
  - name: Endpoints de webhook
    description: Les URL de votre serveur qui reçoivent les événements.
paths:
  /api/v1/plans:
    post:
      tags:
        - Plans
      summary: Créer un plan
      description: >-
        Le prix et le rythme d'un abonnement. Le même plan sert les clients
        carte et mobile money.
      operationId: createPlan
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - amount
                - currency
                - interval
              properties:
                name:
                  type: string
                  description: Nom affiché au client
                  maxLength: 255
                amount:
                  type: integer
                  description: Prix d'un cycle, en unités mineures
                  minimum: 1
                  maximum: 1000000000
                currency:
                  type: string
                  description: Code devise ISO 4217 de 3 lettres, par exemple `XAF`.
                  minLength: 3
                  maxLength: 3
                interval:
                  type: string
                  description: Rythme
                  enum:
                    - daily
                    - weekly
                    - monthly
                    - yearly
                interval_count:
                  type: integer
                  description: >-
                    De 1 à 365, 1 par défaut. `monthly` et `3` : tous les 3
                    mois.
                  minimum: 1
                  maximum: 365
                  default: 1
                trial_period_days:
                  type: integer
                  description: Jours d'essai, de 0 à 365
                  minimum: 0
                  maximum: 365
                  default: 0
                description:
                  type: string
                  description: Description
                  maxLength: 500
                portal_switchable:
                  type: boolean
                  description: Proposé aux abonnés dans leur espace client
                  default: false
                metadata:
                  type:
                    - object
                    - 'null'
                  additionalProperties:
                    type:
                      - string
                      - 'null'
                    maxLength: 500
                  description: >-
                    Vos données libres, renvoyées telles quelles. 50 clés
                    maximum, valeurs de 500 caractères maximum.
            example:
              name: Abonnement Pro
              amount: 5000
              currency: XAF
              interval: monthly
              trial_period_days: 7
      responses:
        '201':
          description: Plan créé
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Plan'
              example:
                data:
                  id: plan_9b1e4c2a6d3f4a5e8f6c2d9b1a7e3c48
                  object: plan
                  livemode: false
                  created: '2026-11-01T09:00:00+00:00'
                  name: Abonnement Pro
                  description: Accès complet, support prioritaire
                  amount: 5000
                  currency: XAF
                  interval: monthly
                  interval_count: 1
                  trial_period_days: 7
                  status: active
                  portal_switchable: true
                  metadata:
                    tier: pro
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: >-
        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](/developers/idempotency).
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
          description: Identifiant du plan (`plan_…`)
        object:
          type: string
          const: plan
        livemode:
          type: boolean
          description: '`true` pour de l''argent réel (clé live), `false` en sandbox'
        created:
          type:
            - string
            - 'null'
          format: date-time
          description: Date de création, ISO 8601
        name:
          type: string
          description: Nom affiché au client
        description:
          type:
            - string
            - 'null'
          description: Description
        amount:
          type: integer
          description: Prix d'un cycle, en unités mineures
        currency:
          type: string
          description: Devise
        interval:
          type: string
          description: Rythme
          enum:
            - daily
            - weekly
            - monthly
            - yearly
        interval_count:
          type: integer
          description: 'Nombre d''`interval` par cycle : `monthly` et `3`, tous les 3 mois.'
        trial_period_days:
          type: integer
          description: Jours d'essai, `0` sans essai
        status:
          type: string
          description: '`archived` : plus de nouvel abonné'
          enum:
            - active
            - archived
        portal_switchable:
          type: boolean
          description: Vos abonnés peuvent passer à ce plan depuis leur espace client.
        active_subscriptions_count:
          type: integer
          description: >-
            Abonnements en essai, actifs, en retard, impayés ou en pause.
            Renvoyé par la liste seulement.
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: Vos données libres. Voir [Metadata](/developers/metadata).
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request_error
                - idempotency_error
                - payment_error
                - rate_limit_error
                - api_error
            code:
              type: string
              description: Code stable, à tester dans votre code
            message:
              type: string
              description: Explication en français, pour un humain
            param:
              type:
                - string
                - 'null'
              description: Le premier champ en cause
            doc_url:
              type: string
              description: Explication de ce code
            request_id:
              type: string
              description: >-
                Identifiant de la requête (`req_…`), aussi dans l'en-tête
                `Request-Id`
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
              description: Détail par champ refusé, sur une erreur `422`
      required:
        - error
  responses:
    Unauthorized:
      description: Clé absente, invalide ou révoquée
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: api_key_invalid
              message: Clé API invalide.
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#api_key_invalid
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
    Forbidden:
      description: Compte suspendu, ou clé live avant l'approbation du KYC
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: live_mode_requires_kyc
              message: Le mode live demande un KYC approuvé.
              param: null
              doc_url: >-
                https://docs.mercy-pay.com/developers/errors#live_mode_requires_kyc
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
    Conflict:
      description: Conflit avec l'état de la ressource, ou clé d'idempotence réutilisée
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: conflict
              message: 'Cette ressource est utilisée : archivez-la.'
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#conflict
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
    ValidationFailed:
      description: Données invalides, avec le détail dans `errors`
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: validation_failed
              message: Le champ amount est obligatoire.
              param: amount
              doc_url: https://docs.mercy-pay.com/developers/errors#validation_failed
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
              errors:
                amount:
                  - Le champ amount est obligatoire.
    RateLimited:
      description: Plus de 60 requêtes par minute avec cette clé
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limit_error
              code: rate_limited
              message: Trop de requêtes.
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#rate_limited
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Votre clé API. Utilisez une clé sandbox (`mp_sandbox_…`) pour essayer :
        aucun argent réel ne bouge.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.