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

subscriptionContractCreate mutation

Version 2021-01 (Release candidate)

Creates a Subscription Contract.

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.


input ( SubscriptionContractCreateInput! ) required

The properties of the new Subscription Contract.

SubscriptionContractCreateInput fields

contract (SubscriptionDraftInput!) Required

The attributes used as input for the Subscription Draft.

currencyCode (CurrencyCode!) Required

The currency used for the subscription contract.

customerId (ID!) Required

The ID of the customer to associate with the subscription contract.

nextBillingDate (DateTime!) Required

The next billing date for the subscription contract.

Return fields

draft (SubscriptionDraft)

The Subscription Contract object.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.