概要
APIリファレンス
指定された定期購買IDの詳細情報を取得する。
| 項目名 | 内容 |
|---|---|
| アクション名 | getSubscription |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | 入力例 | 備考 |
|---|---|---|---|---|
| subscriptionId | 定期購買ID | はい | gid://shopify/SubscriptionContract/123456789 |
指定された定期購買IDの詳細情報を返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| originOrderId | string | null |
| originOrderToken | string | null |
| originOrderName | string | null |
| customerDisplayName | string | null |
| customerPaymentMethodId | number | null |
| subscriptionContractId | string | 契約情報のShopify管理ID |
| billingPolicyInterval | string | 契約情報の決済周期（単位） |
| billingPolicyIntervalCount | number | 契約情報の決済周期 |
| billingPolicyMinCycles | number | null |
| billingPolicyMaxCycles | number | null |
| status | string | 契約情報のステータス（ACTIVE、PAUSED、CANNCELLED） |
| deliveryPriceAmount | number | null |
| deliveryPriceCurrencyCode | string | 契約情報の決済時配送料金通貨 |
| deliveryAddress1 | string | null |
| deliveryAddress2 | string | null |
| deliveryCity | string | null |
| deliveryCompany | string | null |
| deliveryCountry | string | null |
| deliveryCountryCode | string | null |
| deliveryFirstName | string | null |
| deliveryLastName | string | null |
| deliveryName | string | null |
| deliveryPhone | string | null |
| deliveryProvince | string | null |
■異常時レスポンス
| --- | --- | --- |