Skip to main content

BillingAttempt

2回目以降決済情報

type BillingAttempt {
  id: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  completedAt: DateTime
  ready: Boolean
  errorCode: String
  errorMessage: String
  order: Order
  orderName: String
  variantIds: String
  productTitles: String
  subscriptionContract: SubscriptionContract
}

Fields​

BillingAttempt.id ● String! non-null scalar​

決済ID

  • 説明： 2回目以降決済情報の globally-unique ID
  • 例: "gid://shopify/SubscriptionBillingAttempt/1234567890"

BillingAttempt.createdAt ● DateTime! non-null scalar​

決済作成日時

  • 例： "2025-01-21T14:00:00+09:00"
  • 備考: JST形式で表記

BillingAttempt.updatedAt ● DateTime! non-null scalar​

決済更新日時

  • 例： "2025-01-21T14:00:00+09:00"
  • 備考: JST形式で表記

BillingAttempt.completedAt ● DateTime scalar​

決済完了日時

  • 例： "2025-01-21T14:00:00+09:00"
  • 備考: JSTで表記 null の場合、決済は完了していない

BillingAttempt.ready ● Boolean scalar​

決済試行プロセス完了フラグ

  • 説明： 決済試行プロセス完了を表すフラグ
  • 備考: true: 完了 false: 未完了

BillingAttempt.errorCode ● String scalar​

決済エラーコード

  • 説明： 決済試行エラー時のコード
  • 例: "PAYMENT_DECLINED"
  • 備考: null の場合、エラーなし

BillingAttempt.errorMessage ● String scalar​

決済エラーメッセージ

  • 説明： 決済試行エラー時のメッセージ
  • 例: "カードの残高不足"
  • null の場合、エラーなし

BillingAttempt.order ● Order object​

注文情報

  • 説明： 決済成功時の注文情報

BillingAttempt.orderName ● String scalar​

決済成功時の注文番号

  • 例: "#12345"

BillingAttempt.variantIds ● String scalar​

購入された商品バリエーション ID

  • 説明： 購入された商品バリエーション ID
  • 例: "gid://shopify/ProductVariant/111, gid://shopify/ProductVariant/222"

BillingAttempt.productTitles ● String scalar​

購入された商品名

  • 説明： 購入された商品名
  • 例: "アイスクリーム定期便, チョコレートギフトセット"

BillingAttempt.subscriptionContract ● SubscriptionContract object​

関連する定期購買契約情報

  • 説明： 定期購買情報

Example​

{
  "id": "gid://shopify/SubscriptionBillingAttempt/1234567890",
  "createdAt": "2025-01-21T14:00:00+09:00",
  "updatedAt": "2025-01-21T14:00:00+09:00",
  "completedAt": "2025-01-21T14:00:00+09:00",
  "ready": true,
  "errorCode": null,
  "errorMessage": null,
  "order": {
    "id": "gid://shopify/Order/1234567890",
    "createdAt": "2025-01-21T14:00:00+09:00",
    "updatedAt": "2025-01-21T14:00:00+09:00",
    "paidAt": "2025-01-21T14:00:00+09:00",
    "amount": 5000,
    "currencyCode": "JPY"
  },
  "orderName": "#12345",
  "variantIds": "gid://shopify/ProductVariant/111, gid://shopify/ProductVariant/222",
  "productTitles": "アイスクリーム定期便, チョコレートギフトセット",
  "subscriptionContract": {
    "id": "gid://shopify/SubscriptionContract/1234567890"
  }
}

Returned By​

billingAttempts query

Member Of​

SubscriptionContract object