CustomerSubscriptionContractBillingAttempt
顧客向け契約情報取得用BillingAttempt
type CustomerSubscriptionContractBillingAttempt {
createdAt: String!
orderId: String
orderName: String
orderToken: String
ready: Boolean
isSkipGift: Boolean!
giftReceiverPageUrl: String
giftExpiredAt: String
nextActionUrl: String
errorCode: String
errorMessage: String
}
Fields
CustomerSubscriptionContractBillingAttempt.createdAt
● String!
non-null scalar
決済日
- 説明: 支払いが実施された日
- データ例:
"2025-01-14T03:00:06.975Z"
- 備考: UTC
CustomerSubscriptionContractBillingAttempt.orderId
● String
scalar
注文情報の Shopify 管理 ID
- 説明: 関連する注文の Shopify ID
- データ例:
"gid://shopify/Order/5886465867889"
- 備考: null:決済試行して注文が未確定の場合
CustomerSubscriptionContractBillingAttempt.orderName
● String
scalar
注文情報の Shopify 注文名
- 説明: 関連する注文の Shopify 注文名
- データ例:
"#2401"
- 備考: null:決済試行して注文が未確定の場合
CustomerSubscriptionContractBillingAttempt.orderToken
● String
scalar
注文情報の Shopify トークン
- 説明: 関連する注文のトークン
- データ例:
"5d9287cec162819e5daeab15ecd52e16"
- 備考: null:決済試行して注文が未確定の場合
CustomerSubscriptionContractBillingAttempt.ready
● Boolean
scalar
決済試行プロセス完了フラグ
- 説明: 決済プロセスが完了しているか
- データ例:
TRUE
- 備考: TRUE:決済済み, FALSE または null:決済中
CustomerSubscriptionContractBillingAttempt.isSkipGift
● Boolean!
non-null scalar
スキップギフトによる決済判別フラグ
- 説明: スキップギフトによる決済かどうか
- データ例:
TRUE
- 備考: TRUE:ギフト注文による決済, FALSE:通常注文による決済
CustomerSubscriptionContractBillingAttempt.giftReceiverPageUrl
● String
scalar
ギフトの受取URL
- 説明: ギフトの受取URL
- データ例:
"https://gift.com/0ce7dd99-c4dd-4626-ab5c-ce13966b05fe"
CustomerSubscriptionContractBillingAttempt.giftExpiredAt
● String
scalar
ギフト有効期限
- 説明: ギフト有効期限
- データ例:
"2025-01-14T03:00:06.975Z"
- 備考: UTC
CustomerSubscriptionContractBillingAttempt.nextActionUrl
● String
scalar
3D セキュアのチャレンジ URL
- 説明: 3D セキュアによる認証が必要な場合の URL
- データ例:
"https://test-store.myshopify.com/subscriptions/billing/12345/challenge"
CustomerSubscriptionContractBillingAttempt.errorCode
● String
scalar
Shopify決済エラーコード
- 説明: Shopify決済エラーコード
- データ例:
"AMOUNT_TOO_SMALL"
- 備考: https://shopify.dev/docs/api/admin-graphql/2024-04/enums/SubscriptionBillingAttemptErrorCode
CustomerSubscriptionContractBillingAttempt.errorMessage
● String
scalar
Shopify決済エラーメッセージ
- 説明: Shopify決済エラーメッセージ
- データ例:
"The amount is too small."
- 備考: https://shopify.dev/docs/api/admin-graphql/2024-04/enums/SubscriptionBillingAttemptErrorCode
Example
{
"createdAt": "2025-01-14T03:00:06.975Z",
"orderId": "gid://shopify/Order/5886465867889",
"orderName": "#2401",
"orderToken": "5d9287cec162819e5daeab15ecd52e16",
"ready": true,
"nextActionUrl": "https://test-store.myshopify.com/subscriptions/billing/12345/challenge"
}