Skip to main content
Anchor to subscriptionContractCalculationCommit

subscriptionContractCalculationCommit

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Commits a succeeded subscription contract calculation. For a create or update calculation, committing makes the calculated contract the contract's new active version used for future billing. For a billing cycle edit, committing applies the calculated contract only to the selected cycle.

The calculation must be in a succeeded state, which you can confirm with the subscriptionContractCalculation query. Returns the committed contract as a SubscriptionContract, or a SubscriptionBillingCycleEditedContract for a billing cycle edit.

Learn how to build a subscription contract.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the Subscription Contract Calculation to commit.

Was this section helpful?

Anchor to SubscriptionContractCalculationCommitPayload returnsSubscriptionContractCalculationCommitPayload returns

Anchor to contractcontract
•SubscriptionCommittedContract

The contract produced by committing the calculation. A create or update returns a SubscriptionContract; a billing cycle edit returns a SubscriptionBillingCycleEditedContract.

Anchor to userErrorsuserErrors
•[SubscriptionContractCalculationCommitUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?