SubscriptionBillingAttempt object

Record of an execution of the subscription billing schedule.

Required access

read_own_subscription_contracts access scope.

On this page

Fields

  • completedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the billing attempt was completed.
  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the billing attempt was created.
  • errorCode ([SubscriptionBillingAttemptErrorCode](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempterrorcode))
    A code corresponding to a payment error during processing.
  • errorMessage ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A message describing a payment error during processing.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • idempotencyKey ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A unique key generated by the client to avoid duplicate payments.
  • nextActionUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
  • order ([Order](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
    The result of this billing attempt if completed successfully.
  • ready ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether or not the billing attempt is still processing.
  • subscriptionContract ([SubscriptionContract!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
    The subscription contract.

Types that return SubscriptionBillingAttempt

  • [QueryRoot.subscriptionBillingAttempt](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#subscriptionbillingattempt-2021-01)
  • [SubscriptionContract.billingAttempts](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#billingattempts-2021-01)

Mutations for SubscriptionBillingAttempt

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

An auto-generated type for paginating through multiple SubscriptionBillingAttempts.

On this page

Fields

  • edges ([[SubscriptionBillingAttemptEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([SubscriptionBillingAttempt!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt))
    The item at the end of SubscriptionBillingAttemptEdge.

Types that return SubscriptionBillingAttemptEdge

  • [SubscriptionBillingAttemptConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt#edges-2021-01)