SubscriptionContract
object

Choose a version:

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents a Subscription Contract.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to SubscriptionContract.app app App: The subscription app that the subscription contract is registered to.
Anchor to SubscriptionContract.appAdminUrl appAdminUrl URL: The URL of the subscription contract page on the subscription app.
Anchor to SubscriptionContract.billingAttempts billingAttempts SubscriptionBillingAttemptConnection! non-null: The list of billing attempts associated with the subscription contract.
Anchor to SubscriptionContract.billingPolicy billingPolicy SubscriptionBillingPolicy! non-null: The billing policy associated with the subscription contract.
Anchor to SubscriptionContract.createdAt createdAt DateTime! non-null: The date and time when the subscription contract was created.
Anchor to SubscriptionContract.currencyCode currencyCode CurrencyCode! non-null: The currency that's used for the subscription contract.
Anchor to SubscriptionContract.customAttributes customAttributes [Attribute!]! non-null: A list of the custom attributes to be added to the generated orders.
Anchor to SubscriptionContract.customer customer Customer: The customer to whom the subscription contract belongs.
Anchor to SubscriptionContract.customerPaymentMethod customerPaymentMethod CustomerPaymentMethod: The customer payment method that's used for the subscription contract.
Anchor to SubscriptionContract.deliveryMethod deliveryMethod SubscriptionDeliveryMethod: The delivery method for each billing of the subscription contract.
Anchor to SubscriptionContract.deliveryPolicy deliveryPolicy SubscriptionDeliveryPolicy! non-null: The delivery policy associated with the subscription contract.
Anchor to SubscriptionContract.deliveryPrice deliveryPrice MoneyV2! non-null: The delivery price for each billing of the subscription contract.
Anchor to SubscriptionContract.discounts discounts SubscriptionManualDiscountConnection! non-null: The list of subscription discounts associated with the subscription contract.
Anchor to SubscriptionContract.id id ID! non-null: A globally-unique ID.
Anchor to SubscriptionContract.lastPaymentStatus lastPaymentStatus SubscriptionContractLastPaymentStatus: The current status of the last payment.
Anchor to SubscriptionContract.lines lines SubscriptionLineConnection! non-null: The list of subscription lines associated with the subscription contract.
Anchor to SubscriptionContract.linesCount linesCount Count: The number of lines associated with the subscription contract.
Anchor to SubscriptionContract.nextBillingDate nextBillingDate 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 SubscriptionContract.note note String: The note field that will be applied to the generated orders.
Anchor to SubscriptionContract.orders orders OrderConnection! non-null: A list of the subscription contract's orders.
Anchor to SubscriptionContract.originOrder originOrder Order: The order from which this contract originated.
Anchor to SubscriptionContract.revisionId revisionId UnsignedInt64! non-null: The revision id of the contract.
Anchor to SubscriptionContract.status status SubscriptionContractSubscriptionStatus! non-null: The current status of the subscription contract.
Anchor to SubscriptionContract.updatedAt updatedAt DateTime! non-null: The date and time when the subscription contract was updated.

Was this section helpful?

Anchor to section titled 'Queries'

Queries

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

Was this section helpful?

<?>

SubscriptionContract Queries

SubscriptionContract

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to subscriptionContractActivate subscriptionContractActivate mutation: Activates a Subscription Contract.
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?

<~>

SubscriptionContract Mutations

SubscriptionContract

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to Node Node interface
Anchor to SubscriptionContractBase SubscriptionContractBase interface

Was this section helpful?

||-

SubscriptionContract Implements

SubscriptionContract

SubscriptionContractobject

Fields and connections

Fields and connections from

Queries

Queried by

Mutations

Mutated by

Implements

Implements

SubscriptionContract
object