Skip to main content
Anchor to SubscriptionBillingAttemptState

SubscriptionBillingAttemptState

union

Requires read_own_subscription_contracts access scope.

The state of a subscription billing attempt with state-specific data.

Anchor to Possible typesPossible types

Anchor to SubscriptionBillingAttemptActionRequiredStateSubscriptionBillingAttemptActionRequiredState
•OBJECT

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 SubscriptionBillingAttemptFailedStateSubscriptionBillingAttemptFailedState
•OBJECT

The billing attempt failed due to an error.

Anchor to SubscriptionBillingAttemptPendingStateSubscriptionBillingAttemptPendingState
•OBJECT

The billing attempt is currently being processed.

Anchor to SubscriptionBillingAttemptSuccessStateSubscriptionBillingAttemptSuccessState
•OBJECT

The billing attempt completed successfully and created an order.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to SubscriptionBillingAttempt.stateSubscriptionBillingAttempt.state
•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, the nextActionUrl field provides the redirect URL for customer verification.

Was this section helpful?