---
title: SubscriptionBillingAttempt - GraphQL Admin
description: |-
  A record of an execution of the subscription billing process. Billing attempts use
  idempotency keys to avoid duplicate order creation. A successful billing attempt
  will create an order.
api_version: 2025-10
api_name: admin
type: object
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt
  md: https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt.md
---

# Subscription​Billing​Attempt

object

Requires `read_own_subscription_contracts` access scope.

A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation. A successful billing attempt will create an order.

## Fields

* completed​At

  [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

  The date and time when the billing attempt was completed.

* created​At

  [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

  non-null

  The date and time when the billing attempt was created.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)

  non-null

  A globally-unique ID.

* idempotency​Key

  [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  non-null

  A unique key generated by the client to avoid duplicate payments.

* next​Action​Url

  [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL)

  The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.

* order

  [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order)

  The result of this billing attempt if completed successfully.

* origin​Time

  [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

  The date and time used to calculate fulfillment intervals for a billing attempt that successfully completed after the current anchor date. To prevent fulfillment from being pushed to the next anchor date, this field can override the billing attempt date.

* payment​Group​Id

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  The reference shared between retried payment attempts.

* payment​Session​Id

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  The reference shared between payment attempts with similar payment details.

* processing​Error

  [Subscription​Billing​Attempt​Processing​Error](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/SubscriptionBillingAttemptProcessingError)

  Error information from processing the billing attempt.

* ready

  [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)

  non-null

  Whether the billing attempt is still processing.

* respect​Inventory​Policy

  [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)

  non-null

  Whether the billing attempt respects the merchant's inventory policy.

* subscription​Contract

  [Subscription​Contract!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract)

  non-null

  The subscription contract.

* transactions

  [Order​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderTransactionConnection)

  non-null

  The transactions created by the billing attempt.

### Deprecated fields

* error​Code

  [Subscription​Billing​Attempt​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionBillingAttemptErrorCode)

  Deprecated

* error​Message

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  Deprecated

***

## Map

### Fields and connections with this object

* <->[SubscriptionBillingAttemptConnection.nodes](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionBillingAttemptConnection#returns-nodes)
* {}[SubscriptionBillingAttemptEdge.node](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttemptEdge#field-SubscriptionBillingAttemptEdge.fields.node)
* {}[SubscriptionBillingCycle.billingAttempts](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-SubscriptionBillingCycle.fields.billingAttempts)
* {}[SubscriptionContract.billingAttempts](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract#field-SubscriptionContract.fields.billingAttempts)

***

## Queries

* [subscription​Billing​Attempt](https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionBillingAttempt)

  query

  Returns a `SubscriptionBillingAttempt` resource by ID.

* [subscription​Billing​Attempts](https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionBillingAttempts)

  query

  Returns subscription billing attempts on a store.

***

## \<?>SubscriptionBillingAttempt Queries

### Queried by

* \<?>[subscription​Billing​Attempt](https://shopify.dev/docs/api/admin-graphql/latest/queries/SubscriptionBillingAttempt)
* \<?>[subscription​Billing​Attempts](https://shopify.dev/docs/api/admin-graphql/latest/queries/SubscriptionBillingAttemptConnection)

***

## Mutations

* [subscription​Billing​Attempt​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate)

  mutation

  Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt).

* [subscription​Billing​Cycle​Charge](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingCycleCharge)

  mutation

  Creates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for [subscriptionBillingAttemptCreate](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate). For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt).

***

## <\~> SubscriptionBillingAttempt Mutations

### Mutated by

* <\~>[subscription​Billing​Attempt​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate)
* <\~>[subscription​Billing​Cycle​Charge](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingCycleCharge)

***

## Interfaces

* [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)

  interface

***

## ||-SubscriptionBillingAttempt Implements

### Implements

* ||-[Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)