Nouveau plan (plan_…), même devise. Plus cher au même rythme : la différence au prorata est encaissée tout de suite et le plan change dès le paiement. Sinon : appliqué à la prochaine échéance. Renvoyer le plan actuel retire un changement prévu.
Response
L'abonnement modifié
data
object
Hide child attributes
data.id
string
Identifiant de l'abonnement (sub_…)
data.object
string
Allowed value: "subscription"
data.livemode
boolean
true pour de l'argent réel (clé live), false en sandbox
data.created
string<date-time> | null
Date de création, ISO 8601
data.plan
object
Hide child attributes
data.plan.id
string
Identifiant du plan (plan_…)
data.plan.object
string
Allowed value: "plan"
data.plan.livemode
boolean
true pour de l'argent réel (clé live), false en sandbox
data.plan.created
string<date-time> | null
Date de création, ISO 8601
data.plan.name
string
Nom affiché au client
data.plan.description
string | null
Description
data.plan.amount
integer
Prix d'un cycle, en unités mineures
data.plan.currency
string
Devise
data.plan.interval
enum<string>
Rythme
Available options:
daily,
weekly,
monthly,
yearly
data.plan.interval_count
integer
Nombre d'interval par cycle : monthly et 3, tous les 3 mois.
data.plan.trial_period_days
integer
Jours d'essai, 0 sans essai
data.plan.status
enum<string>
archived : plus de nouvel abonné
Available options:
active,
archived
data.plan.portal_switchable
boolean
Vos abonnés peuvent passer à ce plan depuis leur espace client.
data.plan.active_subscriptions_count
integer
Abonnements en essai, actifs, en retard, impayés ou en pause. Renvoyé par la liste seulement.
Ce que votre client doit encore faire. Décidez selon type, pas selon la seule présence du champ : un futur moyen de paiement pourra ajouter son propre type.
Hide child attributes
data.next_action.type
enum<string>
card_payment (confirmer une carte depuis votre formulaire) ou redirect (envoyer le client sur redirect_url).
Available options:
card_payment,
redirect
data.next_action.client_secret
string
card_payment : secret qui confirme le paiement depuis votre formulaire.
data.next_action.redirect_url
string<uri>
redirect : page hébergée où le client termine.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Mercy Pay","description":"Documentation de l'API Mercy Pay, encaissements, soldes et retraits pour prestataires de services.","colors":{"primary":"#FF9D00","light":"#FFC266","dark":"#CC7D00"},"logo":{"light":"https://mintcdn.com/mercy-pay-docs/C4bFF0BtqkbS1HgA/logo/light.svg?fit=max\u0026auto=format\u0026n=C4bFF0BtqkbS1HgA\u0026q=85\u0026s=fdfdcf01b6c0787ec76fcfbe7ce24162","dark":"https://mintcdn.com/mercy-pay-docs/C4bFF0BtqkbS1HgA/logo/dark.svg?fit=max\u0026auto=format\u0026n=C4bFF0BtqkbS1HgA\u0026q=85\u0026s=2c398d4f83e3adbb9bad6517c9747dc5"},"favicon":"https://mintcdn.com/mercy-pay-docs/C4bFF0BtqkbS1HgA/logo/favicon-96x96.png?fit=max\u0026auto=format\u0026n=C4bFF0BtqkbS1HgA\u0026q=85\u0026s=05eb70d90621b464cda81eb86844d442","api":{"openapi":"openapi.json","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","php","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://mercy-pay.com"}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#0B0B0E"}},"navbar":{"links":[{"href":"mailto:support@mercy-pay.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://mercy-pay.com/dashboard"}},"footer":{"socials":{"website":"https://mercy-pay.com"},"links":[{"header":"Mercy Pay","items":[{"label":"Site","href":"https://mercy-pay.com"},{"label":"Tarifs","href":"https://mercy-pay.com/tarifs"},{"label":"Statut","href":"https://mercy-pay.com/statut"},{"label":"Charte graphique","href":"https://mercy-pay.com/documents/mercy-pay-charte-graphique.pdf"}]},{"header":"Légal","items":[{"label":"Conditions générales","href":"https://mercy-pay.com/cgu"},{"label":"Conditions de l'API","href":"https://mercy-pay.com/conditions-api"},{"label":"Confidentialité","href":"https://mercy-pay.com/confidentialite"}]},{"header":"Pour les IA","items":[{"label":"llms.txt","href":"https://docs.mercy-pay.com/llms.txt"},{"label":"llms-full.txt","href":"https://docs.mercy-pay.com/llms-full.txt"}]}]},"fonts":{"family":"Nunito"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Tableau de bord","icon":"layout-dashboard","href":"https://mercy-pay.com/dashboard"},{"anchor":"État des services","icon":"activity","href":"https://mercy-pay.com/statut"},{"anchor":"Support","icon":"life-buoy","href":"mailto:support@mercy-pay.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mercy-pay-docs","hasAudioNarration":false,"actualSubdomain":"mercy-pay-docs","customDomains":["docs.mercy-pay.com"],"gitSource":{"type":"github","owner":"gessyken","repo":"mercy-pay","deployBranch":"main","contentDirectory":"docs.mercy-pay.com","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af8eec02e6041f078d8c05a","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Référence API","count":75},{"language":"default","tag":"Abonnements","count":48},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Paiements","count":23},{"language":"default","tag":"Webhooks","count":15},{"language":"default","tag":"Développeurs","count":14},{"language":"default","tag":"Liens de paiement","count":11},{"language":"default","tag":"Soldes et retraits","count":10},{"language":"default","tag":"Clients","count":8},{"language":"default","tag":"Plans","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1280px){#content-container{padding-left:3rem!important;column-gap:2.5rem!important}#content-area{flex:1 1 0%!important;min-width:0!important;width:auto!important}#content-side-layout{flex:0 0 21rem!important;width:21rem!important;max-width:21rem!important}#content-side-layout>*{width:100%!important;max-width:100%!important;min-width:0!important}#content-side-layout:has(#table-of-contents){flex-basis:15rem!important;width:15rem!important;max-width:15rem!important}}.mp-device-pair{display:flex;flex-direction:column;gap:1rem;align-items:center}.mp-device-desktop{width:100%}.mp-device-mobile{width:60%;max-width:280px}@media (min-width: 768px){.mp-device-pair{flex-direction:row;align-items:flex-end}.mp-device-desktop{flex:1 1 auto;min-width:0}.mp-device-mobile{flex:0 0 24%;width:24%}}#navbar .max-w-8xl,#body-content,#content-container{max-width:none!important}#navbar .max-w-8xl{padding-left:1.5rem!important;padding-right:1.5rem!important}.mp-shot-frame,.mp-shot-box{border-radius:14px;overflow:hidden;border:1px solid rgba(127, 127, 127, 0.22);box-shadow:0 12px 32px -12px rgba(255, 157, 0, 0.25)}.mp-shot-frame,.mp-shot-box{line-height:0}.mp-shot-frame img,.mp-shot-box img{width:100%;margin:0!important}.mp-shot-frame{width:100%;max-width:720px;margin-left:auto;margin-right:auto}.mp-shot-narrow{max-width:480px}.mp-shot-mobile{max-width:240px}.mp-shot-pair{max-width:880px;margin-left:auto!important;margin-right:auto!important}.mp-shot-zoom{display:block;width:100%;padding:0;border:0;background:none;cursor:zoom-in}.mp-shot-zoom:focus-visible{outline:2px solid #ff9d00;outline-offset:2px}dialog.mp-shot-overlay{width:100vw;height:100dvh;max-width:none;max-height:none;margin:0;padding:2rem;border:0;background:transparent;cursor:zoom-out}dialog.mp-shot-overlay[open]{display:flex;align-items:center;justify-content:center}dialog.mp-shot-overlay::backdrop{background:rgba(10, 10, 10, 0.85)}dialog.mp-shot-overlay img{max-width:100%;max-height:100%;width:auto;height:auto;object-fit:contain;border-radius:8px;margin:0!important}"}],"page":{"pagePath":"api/subscriptions/update","slug":"/api/subscriptions/update","pageMetadata":{"openapi":"PATCH /api/v1/subscriptions/{id}","title":"Modifier un abonnement","description":"Ne change que les champs envoyés. `payment_method` et `customer_email` ne se modifient pas.","href":"/api/subscriptions/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Ne change que les champs envoyés. \", _jsx(_components.code, {\n children: \"payment_method\"\n }), \" et \", _jsx(_components.code, {\n children: \"customer_email\"\n }), \" ne se modifient pas.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Une étape impossible dans l’état actuel répond `,_jsx(_components.code,{children:`422`}),` sur `,_jsx(_components.code,{children:`subscription`}),`, avec un message qui explique pourquoi.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"PATCH /api/v1/subscriptions/{id}","title":"Modifier un abonnement","description":"Ne change que les champs envoyés. `payment_method` et `customer_email` ne se modifient pas.","href":"/api/subscriptions/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mercy-pay-docs/bf93ee4a8fbaf22f/kenn-hosting-footer.js"],"openApiReferenceData":{"operation":{"tags":["Abonnements"],"operationId":"updateSubscription","summary":"Modifier un abonnement","description":"Ne change que les champs envoyés. `payment_method` et `customer_email` ne se modifient pas.","parameters":["cb3da56a-9b99-4c3e-bf89-3f6f272f13b5"],"requestBody":"eaee96b5-c168-4c8f-b241-a1d05c0b42f6","responses":{"200":"637834a0-7951-40f7-8b7f-0d94e64deff9","401":"7dccdaa5-b590-46c0-8e20-c44b906000d8","404":"0f3bc2d8-c2b8-4303-acf9-c72b5b5e8ff9","422":"e70e643d-842a-4246-8867-c6eebfa3ff73","429":"16654fd1-e8d3-432b-9c31-4bb9ba15f2c2"},"method":"patch","type":"path","servers":["f7be4ff8-7197-43fa-8ad0-8aaccd4a6a44"],"security":["9b9d2556-aa0c-405e-9134-3a7261b24bce"],"path":"/api/v1/subscriptions/{id}","baseUrlOptions":["https://mercy-pay.com"],"title":"Modifier un abonnement","codeSamples":[],"requestExampleLanguages":["bash","php","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cb3da56a-9b99-4c3e-bf89-3f6f272f13b5":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Identifiant de l'abonnement (`sub_…`)","uniqueKey":"","typeLabel":"string"},"description":"Identifiant de l'abonnement (`sub_…`)"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cycles":{"oneOf":[{"type":"integer","description":"Pas en dessous de `cycles_billed`. `null` retire la limite.","minimum":1,"maximum":1000,"uniqueKey":"max_cycles.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Pas en dessous de `cycles_billed`. `null` retire la limite.","minimum":1,"maximum":1000,"uniqueKey":"max_cycles.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cycles","typeLabel":"integer | null"},"customer_name":{"type":"string","description":"Nom du client","maxLength":255,"uniqueKey":"customer_name","typeLabel":"string"},"customer_phone":{"type":"string","description":"Nouveau numéro mobile money","maxLength":32,"uniqueKey":"customer_phone","typeLabel":"string"},"customer_country":{"type":"string","description":"Pays ISO 3166-1 alpha-3, par exemple `CMR`.","uniqueKey":"customer_country","typeLabel":"string"},"customer_provider":{"type":"string","description":"Code opérateur, par exemple `MTN_MOMO_CMR`. Voir [Pays et opérateurs](/payments/overview#pays-et-operateurs).","maxLength":64,"uniqueKey":"customer_provider","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":500,"uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string | null"},"description":"Remplace les métadonnées","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"metadata.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":500,"uniqueKey":"metadata.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string | null"},"description":"Remplace les métadonnées","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"plan":{"type":"string","description":"Nouveau plan (`plan_…`), même devise. Plus cher au même rythme : la différence au prorata est encaissée tout de suite et le plan change dès le paiement. Sinon : appliqué à la prochaine échéance. Renvoyer le plan actuel retire un changement prévu.","uniqueKey":"plan","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"plan":"plan_c7d2e9f13a4b4c5d8e6f1a2b3c4d5e6f"},"examples":{"Example":{"title":"Example","value":{"plan":"plan_c7d2e9f13a4b4c5d8e6f1a2b3c4d5e6f"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"637834a0-7951-40f7-8b7f-0d94e64deff9":{"description":"L'abonnement modifié","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant de l'abonnement (`sub_…`)","uniqueKey":"data.id","typeLabel":"string"},"object":{"type":"string","const":"subscription","uniqueKey":"data.object","typeLabel":"string"},"livemode":{"type":"boolean","description":"`true` pour de l'argent réel (clé live), `false` en sandbox","uniqueKey":"data.livemode","typeLabel":"boolean"},"created":{"oneOf":[{"type":"string","format":"date-time","description":"Date de création, ISO 8601","uniqueKey":"data.created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date de création, ISO 8601","uniqueKey":"data.created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.created","typeLabel":"string\u003cdate-time> | null"},"plan":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant du plan (`plan_…`)","uniqueKey":"data.plan.id","typeLabel":"string"},"object":{"type":"string","const":"plan","uniqueKey":"data.plan.object","typeLabel":"string"},"livemode":{"type":"boolean","description":"`true` pour de l'argent réel (clé live), `false` en sandbox","uniqueKey":"data.plan.livemode","typeLabel":"boolean"},"created":{"oneOf":[{"type":"string","format":"date-time","description":"Date de création, ISO 8601","uniqueKey":"data.plan.created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date de création, ISO 8601","uniqueKey":"data.plan.created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.plan.created","typeLabel":"string\u003cdate-time> | null"},"name":{"type":"string","description":"Nom affiché au client","uniqueKey":"data.plan.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Description","uniqueKey":"data.plan.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description","uniqueKey":"data.plan.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.plan.description","typeLabel":"string | null"},"amount":{"type":"integer","description":"Prix d'un cycle, en unités mineures","uniqueKey":"data.plan.amount","typeLabel":"integer"},"currency":{"type":"string","description":"Devise","uniqueKey":"data.plan.currency","typeLabel":"string"},"interval":{"type":"string","description":"Rythme","enum":["daily","weekly","monthly","yearly"],"uniqueKey":"data.plan.interval","typeLabel":"enum\u003cstring>"},"interval_count":{"type":"integer","description":"Nombre d'`interval` par cycle : `monthly` et `3`, tous les 3 mois.","uniqueKey":"data.plan.interval_count","typeLabel":"integer"},"trial_period_days":{"type":"integer","description":"Jours d'essai, `0` sans essai","uniqueKey":"data.plan.trial_period_days","typeLabel":"integer"},"status":{"type":"string","description":"`archived` : plus de nouvel abonné","enum":["active","archived"],"uniqueKey":"data.plan.status","typeLabel":"enum\u003cstring>"},"portal_switchable":{"type":"boolean","description":"Vos abonnés peuvent passer à ce plan depuis leur espace client.","uniqueKey":"data.plan.portal_switchable","typeLabel":"boolean"},"active_subscriptions_count":{"type":"integer","description":"Abonnements en essai, actifs, en retard, impayés ou en pause. Renvoyé par la liste seulement.","uniqueKey":"data.plan.active_subscriptions_count","typeLabel":"integer"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Vos données libres. Voir [Metadata](/developers/metadata).","uniqueKey":"data.plan.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Vos données libres. Voir [Metadata](/developers/metadata).","uniqueKey":"data.plan.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.plan.metadata","typeLabel":"object | null"}},"uniqueKey":"data.plan","typeLabel":"object"},"pending_plan":{"oneOf":[{"type":"string","description":"Plan appliqué à la prochaine échéance (`plan_…`), `null` sinon","uniqueKey":"data.pending_plan.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plan appliqué à la prochaine échéance (`plan_…`), `null` sinon","uniqueKey":"data.pending_plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pending_plan","typeLabel":"string | null"},"payment_method":{"type":"string","description":"Moyen choisi à l'inscription","enum":["card","mobile_money"],"uniqueKey":"data.payment_method","typeLabel":"enum\u003cstring>"},"customer":{"oneOf":[{"type":"string","description":"Client (`cus_…`). Avec `expand[]=customer`, le client complet","uniqueKey":"data.customer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Client (`cus_…`). Avec `expand[]=customer`, le client complet","uniqueKey":"data.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customer","typeLabel":"string | null"},"customer_name":{"type":"string","description":"Nom du client","uniqueKey":"data.customer_name","typeLabel":"string"},"customer_email":{"type":"string","description":"E-mail du client : reçus, rappels et accès à l'espace client","uniqueKey":"data.customer_email","typeLabel":"string"},"customer_phone":{"oneOf":[{"type":"string","description":"Numéro mobile money","uniqueKey":"data.customer_phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Numéro mobile money","uniqueKey":"data.customer_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customer_phone","typeLabel":"string | null"},"customer_country":{"oneOf":[{"type":"string","description":"Pays du numéro","uniqueKey":"data.customer_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pays du numéro","uniqueKey":"data.customer_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customer_country","typeLabel":"string | null"},"customer_provider":{"oneOf":[{"type":"string","description":"Opérateur du numéro","uniqueKey":"data.customer_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opérateur du numéro","uniqueKey":"data.customer_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customer_provider","typeLabel":"string | null"},"status":{"type":"string","description":"Voir [le cycle de vie](/subscriptions/overview#cycle-de-vie).","enum":["incomplete","trialing","active","past_due","unpaid","paused","canceled"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"current_period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Début de la période en cours","uniqueKey":"data.current_period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Début de la période en cours","uniqueKey":"data.current_period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.current_period_start","typeLabel":"string\u003cdate-time> | null"},"current_period_end":{"oneOf":[{"type":"string","format":"date-time","description":"Fin de la période en cours","uniqueKey":"data.current_period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Fin de la période en cours","uniqueKey":"data.current_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.current_period_end","typeLabel":"string\u003cdate-time> | null"},"trial_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"Fin de l'essai","uniqueKey":"data.trial_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Fin de l'essai","uniqueKey":"data.trial_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.trial_ends_at","typeLabel":"string\u003cdate-time> | null"},"next_billing_at":{"oneOf":[{"type":"string","format":"date-time","description":"Prochaine échéance","uniqueKey":"data.next_billing_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Prochaine échéance","uniqueKey":"data.next_billing_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.next_billing_at","typeLabel":"string\u003cdate-time> | null"},"cancel_at_period_end":{"type":"boolean","description":"`true` : s'arrête à la fin de la période payée","uniqueKey":"data.cancel_at_period_end","typeLabel":"boolean"},"canceled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date d'annulation","uniqueKey":"data.canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date d'annulation","uniqueKey":"data.canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.canceled_at","typeLabel":"string\u003cdate-time> | null"},"paused_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date de mise en pause","uniqueKey":"data.paused_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date de mise en pause","uniqueKey":"data.paused_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paused_at","typeLabel":"string\u003cdate-time> | null"},"resumes_at":{"oneOf":[{"type":"string","format":"date-time","description":"Reprise automatique prévue","uniqueKey":"data.resumes_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Reprise automatique prévue","uniqueKey":"data.resumes_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.resumes_at","typeLabel":"string\u003cdate-time> | null"},"max_cycles":{"oneOf":[{"type":"integer","description":"Nombre d'échéances après lequel l'abonnement s'arrête, `null` sans limite.","uniqueKey":"data.max_cycles.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Nombre d'échéances après lequel l'abonnement s'arrête, `null` sans limite.","uniqueKey":"data.max_cycles.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.max_cycles","typeLabel":"integer | null"},"cycles_billed":{"type":"integer","description":"Échéances déjà facturées","uniqueKey":"data.cycles_billed","typeLabel":"integer"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Vos données libres. Voir [Metadata](/developers/metadata).","uniqueKey":"data.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Vos données libres. Voir [Metadata](/developers/metadata).","uniqueKey":"data.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata","typeLabel":"object | null"},"next_action":{"oneOf":[{"type":"object","description":"Ce que votre client doit encore faire. Décidez selon `type`, pas selon la seule présence du champ : un futur moyen de paiement pourra ajouter son propre `type`.","properties":{"type":{"type":"string","description":"`card_payment` (confirmer une carte depuis votre formulaire) ou `redirect` (envoyer le client sur `redirect_url`).","enum":["card_payment","redirect"],"uniqueKey":"data.next_action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"client_secret":{"type":"string","description":"`card_payment` : secret qui confirme le paiement depuis votre formulaire.","uniqueKey":"data.next_action.oneOf.0.client_secret","typeLabel":"string"},"redirect_url":{"type":"string","description":"`redirect` : page hébergée où le client termine.","format":"uri","uniqueKey":"data.next_action.oneOf.0.redirect_url","typeLabel":"string\u003curi>"}},"uniqueKey":"data.next_action.oneOf.0","typeLabel":"object"},{"type":"null","description":"Ce que votre client doit encore faire. Décidez selon `type`, pas selon la seule présence du champ : un futur moyen de paiement pourra ajouter son propre `type`.","properties":{"type":{"type":"string","description":"`card_payment` (confirmer une carte depuis votre formulaire) ou `redirect` (envoyer le client sur `redirect_url`).","enum":["card_payment","redirect"]},"client_secret":{"type":"string","description":"`card_payment` : secret qui confirme le paiement depuis votre formulaire."},"redirect_url":{"type":"string","description":"`redirect` : page hébergée où le client termine.","format":"uri"}},"uniqueKey":"data.next_action.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.next_action","typeLabel":"object | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"id":"sub_4f2c8a1e0b7d4c559a3e6d1f8b2c7e90","object":"subscription","livemode":false,"created":"2026-11-07T10:00:00+00:00","plan":{"id":"plan_9b1e4c2a6d3f4a5e8f6c2d9b1a7e3c48","object":"plan","livemode":false,"created":"2026-11-01T09:00:00+00:00","name":"Abonnement Pro","description":null,"amount":5000,"currency":"XAF","interval":"monthly","interval_count":1,"trial_period_days":0,"status":"active","portal_switchable":true,"metadata":null},"pending_plan":"plan_c7d2e9f13a4b4c5d8e6f1a2b3c4d5e6f","payment_method":"mobile_money","customer":"cus_c71d0e5a3b2f4e8a9c1d5f6a7b8c9d01","customer_name":"Awa Ndiaye","customer_email":"awa@example.com","customer_phone":"237670000012","customer_country":"CMR","customer_provider":"MTN_MOMO_CMR","status":"active","current_period_start":"2026-11-07T10:00:00+00:00","current_period_end":"2026-12-07T10:00:00+00:00","trial_ends_at":null,"next_billing_at":"2026-12-07T10:00:00+00:00","cancel_at_period_end":false,"canceled_at":null,"paused_at":null,"resumes_at":null,"max_cycles":null,"cycles_billed":1,"metadata":{"customer_id":"cus_1042"},"next_action":null}},"examples":{"Example":{"title":"Example","value":{"data":{"id":"sub_4f2c8a1e0b7d4c559a3e6d1f8b2c7e90","object":"subscription","livemode":false,"created":"2026-11-07T10:00:00+00:00","plan":{"id":"plan_9b1e4c2a6d3f4a5e8f6c2d9b1a7e3c48","object":"plan","livemode":false,"created":"2026-11-01T09:00:00+00:00","name":"Abonnement Pro","description":null,"amount":5000,"currency":"XAF","interval":"monthly","interval_count":1,"trial_period_days":0,"status":"active","portal_switchable":true,"metadata":null},"pending_plan":"plan_c7d2e9f13a4b4c5d8e6f1a2b3c4d5e6f","payment_method":"mobile_money","customer":"cus_c71d0e5a3b2f4e8a9c1d5f6a7b8c9d01","customer_name":"Awa Ndiaye","customer_email":"awa@example.com","customer_phone":"237670000012","customer_country":"CMR","customer_provider":"MTN_MOMO_CMR","status":"active","current_period_start":"2026-11-07T10:00:00+00:00","current_period_end":"2026-12-07T10:00:00+00:00","trial_ends_at":null,"next_billing_at":"2026-12-07T10:00:00+00:00","cancel_at_period_end":false,"canceled_at":null,"paused_at":null,"resumes_at":null,"max_cycles":null,"cycles_billed":1,"metadata":{"customer_id":"cus_1042"},"next_action":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"7dccdaa5-b590-46c0-8e20-c44b906000d8":{"description":"Clé absente, invalide ou révoquée","content":{"application/json":{"schema":{"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"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Code stable, à tester dans votre code","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explication en français, pour un humain","uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","description":"Explication de ce code","uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"type":"string","description":"Identifiant de la requête (`req_…`), aussi dans l'en-tête `Request-Id`","uniqueKey":"error.request_id","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"description":"Détail par champ refusé, sur une erreur `422`","uniqueKey":"error.errors","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"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"}},"examples":{"Example":{"title":"Example","value":{"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"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0f3bc2d8-c2b8-4303-acf9-c72b5b5e8ff9":{"description":"Ressource inconnue, ou d'un autre marchand ou environnement","content":{"application/json":{"schema":{"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"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Code stable, à tester dans votre code","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explication en français, pour un humain","uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","description":"Explication de ce code","uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"type":"string","description":"Identifiant de la requête (`req_…`), aussi dans l'en-tête `Request-Id`","uniqueKey":"error.request_id","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"description":"Détail par champ refusé, sur une erreur `422`","uniqueKey":"error.errors","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"invalid_request_error","code":"resource_not_found","message":"Ressource introuvable.","param":null,"doc_url":"https://docs.mercy-pay.com/developers/errors#resource_not_found","request_id":"req_01jc8x4m2v7t9qk3n5w6y8z0ab"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"resource_not_found","message":"Ressource introuvable.","param":null,"doc_url":"https://docs.mercy-pay.com/developers/errors#resource_not_found","request_id":"req_01jc8x4m2v7t9qk3n5w6y8z0ab"}}}},"exampleType":"examples"}},"exampleType":"examples"},"e70e643d-842a-4246-8867-c6eebfa3ff73":{"description":"Données invalides, avec le détail dans `errors`","content":{"application/json":{"schema":{"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"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Code stable, à tester dans votre code","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explication en français, pour un humain","uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","description":"Explication de ce code","uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"type":"string","description":"Identifiant de la requête (`req_…`), aussi dans l'en-tête `Request-Id`","uniqueKey":"error.request_id","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"description":"Détail par champ refusé, sur une erreur `422`","uniqueKey":"error.errors","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"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."]}}},"examples":{"Example":{"title":"Example","value":{"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."]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"16654fd1-e8d3-432b-9c31-4bb9ba15f2c2":{"description":"Plus de 60 requêtes par minute avec cette clé","content":{"application/json":{"schema":{"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"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Code stable, à tester dans votre code","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explication en français, pour un humain","uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Le premier champ en cause","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","description":"Explication de ce code","uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"type":"string","description":"Identifiant de la requête (`req_…`), aussi dans l'en-tête `Request-Id`","uniqueKey":"error.request_id","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.additionalProperties","typeLabel":"string[]"},"description":"Détail par champ refusé, sur une erreur `422`","uniqueKey":"error.errors","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"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"}},"examples":{"Example":{"title":"Example","value":{"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"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9b9d2556-aa0c-405e-9134-3a7261b24bce":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Votre clé API. Utilisez une clé sandbox (`mp_sandbox_…`) pour essayer : aucun argent réel ne bouge.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"f7be4ff8-7197-43fa-8ad0-8aaccd4a6a44":{"url":"https://mercy-pay.com","description":"Production. La clé choisit l'environnement : `mp_sandbox_…` ou `mp_live_…`."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Votre clé API. Utilisez une clé sandbox (`mp_sandbox_…`) pour essayer : aucun argent réel ne bouge.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Votre clé API. Utilisez une clé sandbox (`mp_sandbox_…`) pour essayer : aucun argent réel ne bouge.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"mercy-pay-docs","siteName":"Mercy Pay","title":"Modifier un abonnement - Mercy Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T15:27:57.326Z","originalFileLocation":"api/subscriptions/update.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Ne change que les champs envoyés. payment_method et customer_email ne se modifient pas.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mercy Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Modifier un abonnement - Mercy Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ne change que les champs envoyés. payment_method et customer_email ne se modifient pas.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mercy Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mercy-pay.com/api/subscriptions/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mercy-pay-docs.mintlify.site/_mintlify/api/og/v2?division=Abonnements\u0026amp;title=Modifier+un+abonnement\u0026amp;description=Ne+change+que+les+champs+envoy%C3%A9s.+%60payment_method%60+et+%60customer_email%60+ne+se+modifient+pas.\u0026amp;theme=29103f8f5341b6104078e85b\u0026amp;signature=6ecec5a1b914e1dc7c41d930bf5b1e6ea7b95bf3cd3450df2a7920522ae34c84\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Modifier un abonnement - Mercy Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ne change que les champs envoyés. payment_method et customer_email ne se modifient pas.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mercy-pay-docs.mintlify.site/_mintlify/api/og/v2?division=Abonnements\u0026amp;title=Modifier+un+abonnement\u0026amp;description=Ne+change+que+les+champs+envoy%C3%A9s.+%60payment_method%60+et+%60customer_email%60+ne+se+modifient+pas.\u0026amp;theme=29103f8f5341b6104078e85b\u0026amp;signature=6ecec5a1b914e1dc7c41d930bf5b1e6ea7b95bf3cd3450df2a7920522ae34c84\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mercy-pay-docs/FIGo4BWVKJadbUOG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mercy Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF9D00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mercy-pay.com/api/subscriptions/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/subscriptions/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mercy-pay.com/#organization\",\"name\":\"Mercy Pay\",\"url\":\"https://docs.mercy-pay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mercy-pay-docs/C4bFF0BtqkbS1HgA/logo/light.svg?fit=max\u0026auto=format\u0026n=C4bFF0BtqkbS1HgA\u0026q=85\u0026s=fdfdcf01b6c0787ec76fcfbe7ce24162\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mercy-pay.com#website\",\"name\":\"Mercy Pay\",\"url\":\"https://docs.mercy-pay.com\",\"publisher\":{\"@id\":\"https://docs.mercy-pay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mercy-pay.com/api/subscriptions/update#webpage\",\"url\":\"https://docs.mercy-pay.com/api/subscriptions/update\",\"name\":\"Modifier un abonnement\",\"description\":\"Ne change que les champs envoyés. payment_method et customer_email ne se modifient pas.\",\"dateModified\":\"2026-11-07T15:27:57.326Z\",\"isPartOf\":{\"@id\":\"https://docs.mercy-pay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mercy-pay.com/api/subscriptions/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mercy-pay.com/api/subscriptions/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Abonnements\",\"item\":\"https://docs.mercy-pay.com/api/plans/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Abonnements\",\"item\":\"https://docs.mercy-pay.com/api/subscriptions/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Modifier un abonnement\",\"item\":\"https://docs.mercy-pay.com/api/subscriptions/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.mercy-pay.com/api/subscriptions/update#apireference\",\"headline\":\"Modifier un abonnement\",\"name\":\"Modifier un abonnement\",\"description\":\"Ne change que les champs envoyés. payment_method et customer_email ne se modifient pas.\",\"url\":\"https://docs.mercy-pay.com/api/subscriptions/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mercy-pay.com/api/subscriptions/update#webpage\"},\"dateModified\":\"2026-11-07T15:27:57.326Z\",\"publisher\":{\"@id\":\"https://docs.mercy-pay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mercy-pay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mercy Pay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mercy Pay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/subscriptions/update.md","siteName":"Mercy Pay","nav":{"global":{"anchors":[{"anchor":"Tableau de bord","icon":"layout-dashboard","href":"https://mercy-pay.com/dashboard"},{"anchor":"État des services","icon":"activity","href":"https://mercy-pay.com/statut"},{"anchor":"Support","icon":"life-buoy","href":"mailto:support@mercy-pay.com"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Référence API","icon":"braces","groups":[{"group":"Introduction","icon":"book-open","pages":[{"title":"Authentification","href":"/developers/authentication"},{"title":"Erreurs","href":"/developers/errors"},{"title":"Idempotence","href":"/developers/idempotency"},{"title":"Limites de débit","href":"/developers/rate-limits"},{"title":"Pagination","href":"/developers/pagination"},{"title":"Metadata","href":"/developers/metadata"},{"title":"Objets liés","href":"/developers/expand"}]},{"group":"Compte","icon":"user","pages":[{"openapi":"GET /api/v1/account","title":"Lire le compte","href":"/api/account/get"},{"openapi":"GET /api/v1/provider_status","title":"État des opérateurs","href":"/api/provider-status/get"},{"openapi":"POST /api/v1/fees/quote","title":"Calculer les frais d'un paiement","href":"/api/fees/quote"}]},{"group":"Paiements","icon":"credit-card","pages":[{"group":"Sessions de paiement","icon":"panel-top","expanded":true,"pages":[{"openapi":"POST /api/v1/checkout_sessions","title":"Créer une session","href":"/api/checkout-sessions/create"},{"openapi":"GET /api/v1/checkout_sessions","title":"Lister les sessions","href":"/api/checkout-sessions/list"},{"openapi":"GET /api/v1/checkout_sessions/{id}","title":"Lire une session","href":"/api/checkout-sessions/get"},{"openapi":"POST /api/v1/checkout_sessions/{id}/expire","title":"Expirer une session","href":"/api/checkout-sessions/expire"}]},{"group":"Paiements","icon":"banknote","expanded":true,"pages":[{"openapi":"POST /api/v1/payments","title":"Encaisser un paiement","href":"/api/payments/create"},{"openapi":"GET /api/v1/payments","title":"Lister les paiements","href":"/api/payments/list"},{"openapi":"GET /api/v1/payments/{id}","title":"Lire un paiement","href":"/api/payments/get"}]},{"group":"Remboursements","pages":[{"title":"Rembourser un paiement","openapi":"POST /api/v1/payments/{id}/refunds","href":"/api/refunds/create"},{"title":"Lister les remboursements","openapi":"GET /api/v1/refunds","href":"/api/refunds/list"},{"title":"Lire un remboursement","openapi":"GET /api/v1/refunds/{id}","href":"/api/refunds/get"},{"title":"Annuler un remboursement retardé","openapi":"POST /api/v1/refunds/{id}/cancel","href":"/api/refunds/cancel"}]}]},{"group":"Liens de paiement","icon":"link","pages":[{"openapi":"POST /api/v1/payment_links","title":"Créer un lien","href":"/api/payment-links/create"},{"openapi":"GET /api/v1/payment_links","title":"Lister les liens","href":"/api/payment-links/list"},{"openapi":"GET /api/v1/payment_links/{id}","title":"Lire un lien","href":"/api/payment-links/get"},{"openapi":"PATCH /api/v1/payment_links/{id}","title":"Modifier un lien","href":"/api/payment-links/update"},{"openapi":"POST /api/v1/payment_links/{id}/archive","title":"Archiver un lien","href":"/api/payment-links/archive"},{"openapi":"DELETE /api/v1/payment_links/{id}","title":"Supprimer un lien","href":"/api/payment-links/delete"},{"openapi":"GET /api/v1/payment_links/{id}/payments","title":"Paiements d'un lien","href":"/api/payment-links/payments"}]},{"group":"Abonnements","icon":"repeat","pages":[{"group":"Plans","icon":"layers","pages":[{"openapi":"POST /api/v1/plans","title":"Créer un plan","href":"/api/plans/create"},{"openapi":"GET /api/v1/plans","title":"Lister les plans","href":"/api/plans/list"},{"openapi":"GET /api/v1/plans/{id}","title":"Lire un plan","href":"/api/plans/get"},{"openapi":"PATCH /api/v1/plans/{id}","title":"Modifier un plan","href":"/api/plans/update"},{"openapi":"POST /api/v1/plans/{id}/archive","title":"Archiver un plan","href":"/api/plans/archive"},{"openapi":"POST /api/v1/plans/{id}/restore","title":"Réactiver un plan","href":"/api/plans/restore"},{"openapi":"DELETE /api/v1/plans/{id}","title":"Supprimer un plan","href":"/api/plans/delete"}]},{"group":"Abonnements","icon":"repeat","pages":[{"openapi":"POST /api/v1/subscriptions","title":"Créer un abonnement","href":"/api/subscriptions/create"},{"openapi":"GET /api/v1/subscriptions","title":"Lister les abonnements","href":"/api/subscriptions/list"},{"openapi":"GET /api/v1/subscriptions/{id}","title":"Lire un abonnement","description":"Un abonnement, avec son plan.","href":"/api/subscriptions/get"},{"openapi":"PATCH /api/v1/subscriptions/{id}","title":"Modifier un abonnement","href":"/api/subscriptions/update"},{"openapi":"POST /api/v1/subscriptions/{id}/cancel","title":"Annuler un abonnement","description":"Tout de suite, ou à la fin de la période payée avec `at_period_end`.","href":"/api/subscriptions/cancel"},{"openapi":"POST /api/v1/subscriptions/{id}/reactivate","title":"Retirer une annulation prévue","href":"/api/subscriptions/reactivate"},{"openapi":"POST /api/v1/subscriptions/{id}/advance","title":"Passer à l'échéance (sandbox)","href":"/api/subscriptions/advance"},{"openapi":"POST /api/v1/subscriptions/{id}/pause","title":"Mettre en pause","href":"/api/subscriptions/pause"},{"openapi":"POST /api/v1/subscriptions/{id}/resume","title":"Reprendre","href":"/api/subscriptions/resume"},{"openapi":"GET /api/v1/subscriptions/{id}/invoices","title":"Factures d'un abonnement","href":"/api/subscriptions/invoices"}]},{"group":"Clients","icon":"users","pages":[{"openapi":"POST /api/v1/customers","title":"Créer un client","href":"/api/customers/create"},{"openapi":"GET /api/v1/customers","title":"Lister les clients","href":"/api/customers/list"},{"openapi":"GET /api/v1/customers/{id}","title":"Lire un client","href":"/api/customers/get"},{"openapi":"GET /api/v1/customers/{customer}/payment_methods","title":"Moyens de paiement d'un client","href":"/api/customers/payment-methods"},{"openapi":"PATCH /api/v1/customers/{id}","title":"Modifier un client","href":"/api/customers/update"},{"openapi":"DELETE /api/v1/customers/{id}","title":"Supprimer un client","href":"/api/customers/delete"},{"openapi":"POST /api/v1/customers/{customer}/payment_methods/{payment_method}/default","title":"Choisir le moyen par défaut","href":"/api/customers/set-default"},{"openapi":"DELETE /api/v1/customers/{customer}/payment_methods/{payment_method}","title":"Retirer un moyen de paiement","href":"/api/customers/remove-payment-method"}]},{"group":"Factures","icon":"receipt","pages":[{"openapi":"GET /api/v1/invoices","title":"Lister les factures","href":"/api/invoices/list"},{"openapi":"GET /api/v1/invoices/{id}","title":"Lire une facture","href":"/api/invoices/get"},{"openapi":"POST /api/v1/invoices/{id}/pay","title":"Encaisser une facture","href":"/api/invoices/pay"},{"openapi":"POST /api/v1/invoices/{id}/send","title":"Envoyer la facture au client","href":"/api/invoices/send"}]},{"group":"Espace client","icon":"user-round-cog","pages":[{"openapi":"POST /api/v1/billing_portal/sessions","title":"Ouvrir l'espace client","href":"/api/billing-portal/create-session"}]}]},{"group":"Soldes et retraits","icon":"wallet","pages":[{"group":"Soldes","icon":"wallet","expanded":true,"pages":[{"openapi":"GET /api/v1/wallets","title":"Lire les soldes","href":"/api/wallets/list"},{"openapi":"POST /api/v1/wallet_transfers","title":"Virer entre deux soldes","href":"/api/wallet-transfers/create"},{"openapi":"GET /api/v1/wallet_transfers","title":"Lister les virements entre soldes","href":"/api/wallet-transfers/list"}]},{"group":"Retraits","icon":"arrow-up-right","expanded":true,"pages":[{"openapi":"POST /api/v1/payouts","title":"Demander un retrait","href":"/api/payouts/create"},{"openapi":"GET /api/v1/payouts","title":"Lister les retraits","href":"/api/payouts/list"},{"openapi":"GET /api/v1/payouts/{id}","title":"Lire un retrait","href":"/api/payouts/get"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"group":"Événements","icon":"activity","expanded":true,"pages":[{"openapi":"GET /api/v1/events","title":"Lister les événements","href":"/api/events/list"},{"openapi":"GET /api/v1/events/{id}","title":"Lire un événement","href":"/api/events/get"},{"openapi":"GET /api/v1/events/{id}/deliveries","title":"Lister les envois d'un événement","href":"/api/events/deliveries"},{"openapi":"POST /api/v1/events/{id}/resend","title":"Renvoyer un événement","href":"/api/events/resend"}]},{"group":"Endpoints","icon":"plug","expanded":true,"pages":[{"openapi":"POST /api/v1/webhook_endpoints","title":"Créer un endpoint","href":"/api/webhook-endpoints/create"},{"openapi":"GET /api/v1/webhook_endpoints","title":"Lister les endpoints","href":"/api/webhook-endpoints/list"},{"openapi":"GET /api/v1/webhook_endpoints/{id}","title":"Lire un endpoint","href":"/api/webhook-endpoints/get"},{"openapi":"PATCH /api/v1/webhook_endpoints/{id}","title":"Modifier un endpoint","href":"/api/webhook-endpoints/update"},{"openapi":"DELETE /api/v1/webhook_endpoints/{id}","title":"Supprimer un endpoint","href":"/api/webhook-endpoints/delete"},{"openapi":"POST /api/v1/webhook_endpoints/{id}/rotate_secret","title":"Changer le secret","href":"/api/webhook-endpoints/rotate-secret"},{"openapi":"POST /api/v1/webhook_endpoints/{id}/test","title":"Envoyer un test","href":"/api/webhook-endpoints/test"}]}]}]}]},"basePath":"","title":"Modifier un abonnement - Mercy Pay","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}