各種APIの利用可能条件の一覧です。
利用可能条件から外れている場合、APIからはエラーが返却されます。
※ “-” は「条件無し」を意味します。
| API名 | 利用可能契約種別 | 利用可能契約ステータス | その他の利用条件 |
|---|---|---|---|
| token | - | - | - |
| getSubscriptions | - | - | - |
| getSubscription | - | - | - |
| updateSubscription | 通常定期/一括支払い定期 | アクティブ/一時停止 | - |
| updateSubscriptionV2 | 通常定期 | アクティブ/一時停止 | - |
| updateSubscriptionNote | 通常定期/一括支払い定期 | アクティブ/一時停止/解約 | - |
| validateDeliveryAddress | - | - | 配送先住所のバリデーション機能設定をON |
| updateDeliveryAddress | 通常定期/一括支払い定期 | アクティブ/一時停止/解約 | - |
| confirmSkipSubscription | 通常定期 | アクティブ | - |
| confirmSkipCancelSubscription | 通常定期 | アクティブ | - |
| skipSubscription | 通常定期 | アクティブ | - |
| skipCancelSubscription | 通常定期 | アクティブ | - |
| updateNextDeliveryDate | 通常定期/一括支払い定期 | アクティブ/一時停止 | - |
| updateDeliveryDays | 通常定期/一括支払い定期 | アクティブ/一時停止 | - |
| addSubscriptionLine | 通常定期 | アクティブ/一時停止 | - |
| removeSubscriptionLine | 通常定期 | アクティブ/一時停止 | - |
| changeSubscriptionLine | 通常定期 | アクティブ/一時停止 | - |
| updateSubscriptionLine | 通常定期 | アクティブ/一時停止 | - |
| getChangeableCycles | 通常定期 | アクティブ/一時停止/解約 | - |
| getSubscriptionLinePlan | 通常定期/一括支払い定期 | アクティブ/一時停止/解約 | - |
| updateSubscriptionLinePlan | 通常定期 | アクティブ/一時停止 | - |
| updateSubscriptionLinePlanV2 | 通常定期 | アクティブ/一時停止 | - |
| getPaymentMethod | 通常定期/一括支払い定期 | アクティブ/一時停止/解約 | - |
| paymentMethodUpdate | 通常定期/一括支払い定期 | アクティブ/一時停止 | - |
| updateSubscriptionCouponHistory | 通常定期 | アクティブ/一時停止/解約 | - |
| removeSubscriptionDiscountCoupon | 通常定期 | アクティブ | - |
| getBox | 通常定期 | アクティブ/一時停止/解約 | - |
| updateBoxSubscription | 通常定期 | アクティブ/一時停止/解約 | - |
| getProductDetails | - | - | - |
| getProductVariant | - | - | - |
| getProductVariantV2 | - | - | - |
| getPlanGroups | - | - | - |
| getAlternativeProducts | - | - | - |
| getCancelSurvey | - | - | - |
| getSurveySettings | - | - | - |
| getRecommendProductVariants | - | - | - |
| getPurchasedProducts | - | - | - |
| getSubscriptionLinesCustomAttributes | 通常定期/一括支払い定期 | アクティブ/一時停止/解約 | - |
| checkVariantSoldOut | - | - | - |
| getGiftUrl | 通常定期 | アクティブ/一時停止/解約 | スキップギフト機能設定をON |
| newOrder | 通常定期 | アクティブ | - |
| newOrderForActivation | 通常定期 | 一時停止 | - |
| newOrderForSkipGift | 通常定期 | アクティブ | スキップギフト機能設定をON |
| upsertCustomerMetafields | - | - | - |