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
)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
-
QueryRoot.subscriptionBillingAttempt
-
SubscriptionBillingAttempt.node
-
SubscriptionContract.billingAttempts
Mutations for SubscriptionBillingAttempt
-
Creates a new subscription billing attempt.
Implements
An auto-generated type for paginating through multiple SubscriptionBillingAttempts.
On this page
Fields
-
A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return SubscriptionBillingAttempt
-
QueryRoot.subscriptionBillingAttempt
-
SubscriptionBillingAttempt.node
-
SubscriptionContract.billingAttempts
Mutations for SubscriptionBillingAttempt
-
Creates a new subscription billing attempt.
An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
SubscriptionBillingAttempt!
)The item at the end of SubscriptionBillingAttemptEdge.
Types that return SubscriptionBillingAttempt
-
QueryRoot.subscriptionBillingAttempt
-
SubscriptionBillingAttempt.node
-
SubscriptionContract.billingAttempts
Mutations for SubscriptionBillingAttempt
-
Creates a new subscription billing attempt.
Record of an execution of the subscription billing schedule.
Required access
read_own_subscription_contracts
access scope.
On this page
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
-
Creates a new subscription billing attempt.
Implements
An auto-generated type for paginating through multiple SubscriptionBillingAttempts.
On this page
Fields
-
A list of edges.
-
pageInfo (
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!
)A cursor for use in pagination.
-
node (
SubscriptionBillingAttempt!
)The item at the end of SubscriptionBillingAttemptEdge.
Types that return SubscriptionBillingAttemptEdge
Record of an execution of the subscription billing schedule.
Required access
read_own_subscription_contracts
access scope.
On this page
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
-
Creates a new subscription billing attempt.
Implements
An auto-generated type for paginating through multiple SubscriptionBillingAttempts.
On this page
Fields
-
A list of edges.
-
pageInfo (
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!
)A cursor for use in pagination.
-
node (
SubscriptionBillingAttempt!
)The item at the end of SubscriptionBillingAttemptEdge.