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

subscriptionBillingAttemptCreate mutation

Version 2021-01 (Release candidate)

Creates a new subscription billing attempt.

Required access

write_own_subscription_contracts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


subscriptionBillingAttemptInput ( SubscriptionBillingAttemptInput! ) required

The information to apply as a billing attempt.

subscriptionContractId ( ID! ) required

The ID of the subscription contract.

SubscriptionBillingAttemptInput fields

idempotencyKey (String!) Required

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

Return fields

job (Job)

The asynchronous job processing the billing attempt.

subscriptionBillingAttempt (SubscriptionBillingAttempt)

The subscription billing attempt.

userErrors ([BillingAttemptUserError!]!)

List of errors that occurred executing the mutation.