Choose a version:

SubscriptionContract

object

A Subscription Contract.

Anchor to FieldsFields

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 used for the subscription contract.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of custom attributes to be added to the generated orders.
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 •SubscriptionDiscountConnection: The list of subscription discounts associated with the subscription contract.
Anchor to idid •ID! non-nullPre-auth accessible: 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: A 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.
Anchor to notenote •String: A note 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 the 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 upcomingBillingCyclesupcomingBillingCycles •SubscriptionBillingCycleConnection! non-null: The upcoming billing cycles on the subscription contract.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the subscription contract was updated.

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 subscriptionContractCancel subscriptionContractCancel •mutation: Cancels a Subscription Contract.
Anchor to subscriptionContractPause subscriptionContractPause •mutation: Pauses a Subscription Contract.
Anchor to subscriptionContractSelectDeliveryMethod subscriptionContractSelectDeliveryMethod •mutation: Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.

Was this section helpful?

Anchor to InterfacesInterfaces

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

Was this section helpful?