API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SubscriptionBillingAttempt object

Version unstable

Record of an execution of the subscription billing schedule.

Required access

read_own_subscription_contracts access scope.

Fields

completedAt (DateTime)

The date and time when the billing attempt was completed.

createdAt (DateTime!)

The date and time when the billing attempt was created.

errorCode (SubscriptionBillingAttemptErrorCode)

A code corresponding to a payment error during processing.

errorMessage (String)

A message describing a payment error during processing.

id (ID!)

Globally unique identifier.

idempotencyKey (String!)

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

nextActionUrl (URL)

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

order (Order)

The result of this billing attempt if completed successfully.

ready (Boolean!)

Whether or not the billing attempt is still processing.

subscriptionContract (SubscriptionContract!)

The subscription contract.

Types that return SubscriptionBillingAttempt

Mutations for SubscriptionBillingAttempt

subscriptionBillingAttemptCreate

Creates a new subscription billing attempt.

Implements

Version unstable

Fields

edges ([SubscriptionBillingAttemptEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return SubscriptionBillingAttempt

Mutations for SubscriptionBillingAttempt

subscriptionBillingAttemptCreate

Creates a new subscription billing attempt.

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (SubscriptionBillingAttempt!)

The item at the end of SubscriptionBillingAttemptEdge.

Types that return SubscriptionBillingAttempt

Mutations for SubscriptionBillingAttempt

subscriptionBillingAttemptCreate

Creates a new subscription billing attempt.

Version 2021-01 (Release candidate)

Record of an execution of the subscription billing schedule.

Required access

read_own_subscription_contracts access scope.

Fields

completedAt (DateTime)

The date and time when the billing attempt was completed.

createdAt (DateTime!)

The date and time when the billing attempt was created.

errorCode (SubscriptionBillingAttemptErrorCode)

A code corresponding to a payment error during processing.

errorMessage (String)

A message describing a payment error during processing.

id (ID!)

Globally unique identifier.

idempotencyKey (String!)

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

nextActionUrl (URL)

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

order (Order)

The result of this billing attempt if completed successfully.

ready (Boolean!)

Whether or not the billing attempt is still processing.

subscriptionContract (SubscriptionContract!)

The subscription contract.

Types that return SubscriptionBillingAttempt

Mutations for SubscriptionBillingAttempt

subscriptionBillingAttemptCreate

Creates a new subscription billing attempt.

Implements

Version 2021-01 (Release candidate)

On this page

Fields

edges ([SubscriptionBillingAttemptEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (SubscriptionBillingAttempt!)

The item at the end of SubscriptionBillingAttemptEdge.

Types that return SubscriptionBillingAttemptEdge