SubscriptionContract - customer - OBJECT

Version: 2025-01

Description:

A Subscription Contract.

Access Scopes

Fields

  • billingPolicy: SubscriptionBillingPolicy! - The billing policy associated with the subscription contract.
  • createdAt: DateTime! - The date and time when the subscription contract was created.
  • currencyCode: CurrencyCode! - The currency used for the subscription contract.
  • customAttributes: Attribute! - A list of custom attributes to be added to the generated orders.
  • deliveryMethod: SubscriptionDeliveryMethod - The delivery method for each billing of the subscription contract.
  • deliveryPolicy: SubscriptionDeliveryPolicy! - The delivery policy associated with the subscription contract.
  • deliveryPrice: MoneyV2! - The delivery price for each billing of the subscription contract.
  • id: ID! - A globally-unique ID.
  • lastBillingAttemptErrorType: SubscriptionContractLastBillingErrorType - The last billing error type of the contract.
  • lastPaymentStatus: SubscriptionContractLastPaymentStatus - The current status of the last payment.
  • linesCount: Count - The number of lines associated with the subscription contract.
  • nextBillingDate: DateTime - The next billing date for the subscription contract.
  • note: String - A note that will be applied to the generated orders.
  • originOrder: Order - The order from which the contract originated.
  • revisionId: UnsignedInt64! - The revision ID of the contract.
  • status: SubscriptionContractSubscriptionStatus! - The current status of the subscription contract.
  • updatedAt: DateTime! - The date and time when the subscription contract was updated.

Connections

  • lines: SubscriptionLineConnection!
  • orders: OrderConnection!
  • upcomingBillingCycles: SubscriptionBillingCycleConnection!

Related queries

Related mutations

  • subscriptionContractActivate Activates a Subscription Contract.
  • subscriptionContractCancel Cancels a Subscription Contract.
  • subscriptionContractPause Pauses a Subscription Contract.
  • subscriptionContractSelectDeliveryMethod Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.

Related Unions

Examples