Subscription
Requires access scope.
The state of a subscription billing attempt with state-specific data.
Anchor to Possible typesPossible types
- SubscriptionBillingAttemptActionRequiredState (SubscriptionBillingAttemptActionRequiredState)
- SubscriptionBillingAttemptFailedState (SubscriptionBillingAttemptFailedState)
- SubscriptionBillingAttemptPendingState (SubscriptionBillingAttemptPendingState)
- SubscriptionBillingAttemptSuccessState (SubscriptionBillingAttemptSuccessState)
- Anchor to SubscriptionBillingAttemptActionRequiredStateSubscription•OBJECT
Billing Attempt Action Required State The billing attempt state that requires an action to resolve. Must complete the action required for the billing attempt to continue being processed.
- Anchor to actionaction•Subscription
Billing Attempt Action! non-null The action required to resolve the billing attempt.
- •OBJECT
The billing attempt failed due to an error.
- Anchor to errorerror•Subscription
Billing Attempt Error! non-null The error that caused the billing attempt to fail.
- •OBJECT
The billing attempt is currently being processed.
- Anchor to processingprocessing•Boolean!non-null
Always true when the billing attempt is pending.
- •OBJECT
The billing attempt completed successfully and created an order.
- Anchor to orderorder•Order
The order created by the successful billing attempt. May be null if the order was deleted.
Anchor to Fields with this unionFields with this union
- •OBJECT
A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation.
When a billing attempt completes successfully, it creates an
Order. The attempt includes associated payment transactions and any errors that occur during billing. If 3D Secure authentication is required, thefield provides the redirect URL for customer verification.