Skip to main content
Shopify.devShopify.devDocs
Log inSign up
Anchor to subscriptionBillingCycle

subscriptionBillingCycle

query

Returns a subscription billing cycle found either by cycle index or date.

Anchor to Arguments

Arguments

Anchor to billingCycleInputbillingCycleInput
•
SubscriptionBillingCycleInput!required

Input object used to select and use billing cycles.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to SubscriptionBillingCycleSubscriptionBillingCycle
•
SubscriptionBillingCycle

A subscription billing cycle.

billingAttemptExpectedDate•
DateTime!
non-null

The date on which the billing attempt is expected to be made.

billingAttempts
•
SubscriptionBillingAttemptConnection!
non-null

The list of billing attempts associated with the billing cycle.

cycleEndAt•
DateTime!
non-null

The end date of the billing cycle.

cycleIndex•
Int!
non-null

The index of the billing cycle.

cycleStartAt•
DateTime!
non-null

The start date of the billing cycle.

edited•
Boolean!
non-null

Whether this billing cycle was edited.

editedContract•
SubscriptionBillingCycleEditedContract

The active edited contract for the billing cycle.

skipped•
Boolean!
non-null

Whether this billing cycle was skipped.

sourceContract•
SubscriptionContract!
non-null

The subscription contract that the billing cycle belongs to.

status•
SubscriptionBillingCycleBillingCycleStatus!
non-null

The status of the billing cycle.

Was this section helpful?