SubscriptionBillingCycleEditedContract - admin-graphql - OBJECT

Version: 2024-01

Description:

Represents a subscription contract with billing cycles.

Access Scopes

the `read_own_subscription_contracts` or `write_own_subscription_contracts` scope.

Fields

  • app: App - The subscription app that the subscription contract is registered to.
  • appAdminUrl: URL - The URL of the subscription contract page on the subscription app.
  • createdAt: DateTime! - The date and time when the subscription contract was created.
  • currencyCode: CurrencyCode! - The currency that's used for the subscription contract.
  • customAttributes: Attribute! - A list of the custom attributes to be added to the generated orders.
  • customer: Customer - The customer to whom the subscription contract belongs.
  • customerPaymentMethod: CustomerPaymentMethod - The customer payment method that's used for the subscription contract.
  • deliveryMethod: SubscriptionDeliveryMethod - The delivery method for each billing of the subscription contract.
  • deliveryPrice: MoneyV2! - The delivery price for each billing of the subscription contract.
  • lineCount: Int! - The number of lines associated with the subscription contract.
  • note: String - The note field that will be applied to the generated orders.
  • updatedAt: DateTime! - The date and time when the subscription contract was updated.

Connections

  • billingCycles: SubscriptionBillingCycleConnection!
  • discounts: SubscriptionManualDiscountConnection!
  • lines: SubscriptionLineConnection!
  • orders: OrderConnection!

Related queries

Related mutations

  • subscriptionBillingCycleContractDraftCommit Commits the updates of a Subscription Billing Cycle Contract draft.

Related Unions

Examples