Choose a version:

SubscriptionContract

object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents a Subscription Contract.

Anchor to FieldsFields

Anchor to appapp •App: The subscription app that the subscription contract is registered to.
Anchor to appAdminUrlappAdminUrl •URL: The URL of the subscription contract page on the subscription app.
Anchor to billingAttemptsbillingAttempts •SubscriptionBillingAttemptConnection! non-null: The list of billing attempts associated with the subscription contract.
Anchor to billingPolicybillingPolicy •SubscriptionBillingPolicy! non-null: The billing policy associated with the subscription contract.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the subscription contract was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The currency that's used for the subscription contract.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of the custom attributes to be added to the generated orders.
Anchor to customercustomer •Customer: The customer to whom the subscription contract belongs.
Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method that's used for the subscription contract.
Anchor to deliveryMethoddeliveryMethod •SubscriptionDeliveryMethod: The delivery method for each billing of the subscription contract.
Anchor to deliveryPolicydeliveryPolicy •SubscriptionDeliveryPolicy! non-null: The delivery policy associated with the subscription contract.
Anchor to deliveryPricedeliveryPrice •MoneyV2! non-null: The delivery price for each billing of the subscription contract.
Anchor to discountsdiscounts •SubscriptionManualDiscountConnection! non-null: The list of subscription discounts associated with the subscription contract.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lastBillingAttemptErrorTypelastBillingAttemptErrorType •SubscriptionContractLastBillingErrorType: The last billing error type of the contract.
Anchor to lastPaymentStatuslastPaymentStatus •SubscriptionContractLastPaymentStatus: The current status of the last payment.
Anchor to lineslines •SubscriptionLineConnection! non-null: The list of subscription lines associated with the subscription contract.
Anchor to linesCountlinesCount •Count: The number of lines associated with the subscription contract.
Anchor to nextBillingDatenextBillingDate •DateTime: The next billing date for the subscription contract. This field is managed by the apps. Alternatively you can utilize our Billing Cycles APIs, which provide auto-computed billing dates and additional functionalities.
Anchor to notenote •String: The note field that will be applied to the generated orders.
Anchor to ordersorders •OrderConnection! non-null: A list of the subscription contract's orders.
Anchor to originOrderoriginOrder •Order: The order from which this contract originated.
Anchor to revisionIdrevisionId •UnsignedInt64! non-null: The revision id of the contract.
Anchor to statusstatus •SubscriptionContractSubscriptionStatus! non-null: The current status of the subscription contract.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the subscription contract was updated.
Anchor to lineCountlineCount •Int! non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to subscriptionContract subscriptionContract •query: Returns a Subscription Contract resource by ID.
Anchor to subscriptionContracts subscriptionContracts •query: List Subscription Contracts.

Was this section helpful?

Anchor to MutationsMutations

Anchor to subscriptionContractActivate subscriptionContractActivate •mutation: Activates a Subscription Contract. Contract status must be either active, paused, or failed.
Anchor to subscriptionContractAtomicCreate subscriptionContractAtomicCreate •mutation: Creates a Subscription Contract.
Anchor to subscriptionContractCancel subscriptionContractCancel •mutation: Cancels a Subscription Contract.
Anchor to subscriptionContractExpire subscriptionContractExpire •mutation: Expires a Subscription Contract.
Anchor to subscriptionContractFail subscriptionContractFail •mutation: Fails a Subscription Contract.
Anchor to subscriptionContractPause subscriptionContractPause •mutation: Pauses a Subscription Contract.
Anchor to subscriptionContractProductChange subscriptionContractProductChange •mutation: Allows for the easy change of a Product in a Contract or a Product price change.
Anchor to subscriptionContractSetNextBillingDate subscriptionContractSetNextBillingDate •mutation: Sets the next billing date of a Subscription Contract. This field is managed by the apps. Alternatively you can utilize our Billing Cycles APIs, which provide auto-computed billing dates and additional functionalities.
Anchor to subscriptionDraftCommit subscriptionDraftCommit •mutation: Commits the updates of a Subscription Contract draft.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface
Anchor to SubscriptionContractBase SubscriptionContractBase •interface

Was this section helpful?