メインコンテンツへスキップ
クーポンを無効化します。購入者はそのクーポンを使用できなくなり、そのクーポンのプロモーションコードもすべて無効化されます。関連するすべてのコードが解放され、新しいクーポンやプロモーションコードで再び使用できるようになります。
認証: API Key
無効化は取り消せません。無効化したクーポンを再度有効にすることはできず、クーポンを削除することもできません。同じ割引を再び提供するには、新しいクーポンを作成してください。

リクエストボディ

リクエスト例

成功レスポンス (200)

レスポンスフィールド

クーポンの作成のレスポンスと同じです(promotionCodes を除く)。
既存の注文には影響しません。サブスクリプションに適用済みの割引は、そのサブスクリプションの次回のプラン変更まで引き続き適用されます。すでに無効化されたクーポンに対して呼び出すと、クーポンは変更されずに 200 が返ります。

エラー

リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。