Skip to main content
Anchor to BillingAttemptUserError

BillingAttemptUserError

object

Requires read_own_subscription_contracts access scope.

Represents an error that happens during the execution of a billing attempt mutation.

•BillingAttemptUserErrorCode

The error code.

•[String!]

The path to the input field that caused the error.

•String!non-null

The error message.


Was this section helpful?

•mutation

Creates a new subscription billing attempt. For more information, refer to Create a subscription contract.

Arguments

Anchor to subscriptionBillingAttemptInputsubscriptionBillingAttemptInput
•SubscriptionBillingAttemptInput!required

The information to apply as a billing attempt.

Anchor to subscriptionContractIdsubscriptionContractId
•ID!required

The ID of the subscription contract.


Fields

Anchor to subscriptionBillingAttemptsubscriptionBillingAttempt
•SubscriptionBillingAttempt

The subscription billing attempt.

•[BillingAttemptUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Creates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for subscriptionBillingAttemptCreate. For more information, refer to Create a subscription contract.

Arguments

Anchor to billingCycleSelectorbillingCycleSelector
•SubscriptionBillingCycleSelector!required

Select the specific billing cycle to be billed. If the selected billing cycle's billingAttemptExpectedDate is in the past, the originTime of the billing attempt will be set to this date. However, if the billingAttemptExpectedDate is in the future, the originTime will be the current time.

•SubscriptionBillingAttemptInventoryPolicyDefault:PRODUCT_VARIANT_INVENTORY_POLICY

The behaviour to use when updating inventory.

Anchor to subscriptionContractIdsubscriptionContractId
•ID!required

The ID of the subscription contract.


Fields

Anchor to subscriptionBillingAttemptsubscriptionBillingAttempt
•SubscriptionBillingAttempt

The subscription billing attempt.

•[BillingAttemptUserError!]!non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?


Was this section helpful?
OSZAR »