API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

subscriptionBillingAttemptCreate mutation

Version unstable

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.


Arguments

Argument Description
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

Version 2021-04 (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.


Arguments

Argument Description
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

Version 2021-01 (Latest)

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.


Arguments

Argument Description
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