--- title: SubscriptionBillingCycle - GraphQL Admin description: A subscription billing cycle. api_version: unstable api_name: admin source_url: html: >- https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingCycle md: >- https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingCycle.md --- # Subscription​Billing​Cycle object Requires the `read_own_subscription_contracts` or `write_own_subscription_contracts` scope. A subscription billing cycle. ## Fields * billing​Attempt​Expected​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/DateTime) non-null The date on which the billing attempt is expected to be made. * billing​Attempts [Subscription​Billing​Attempt​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/SubscriptionBillingAttemptConnection) non-null The list of billing attempts associated with the billing cycle. * first [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) ### Arguments The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * cycle​End​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/DateTime) non-null The end date of the billing cycle. * cycle​Index [Int!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) non-null The index of the billing cycle. * cycle​Start​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/DateTime) non-null The start date of the billing cycle. * edited [Boolean!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) non-null Whether this billing cycle was edited. * edited​Contract [Subscription​Billing​Cycle​Edited​Contract](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingCycleEditedContract) The active edited contract for the billing cycle. * skipped [Boolean!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) non-null Whether this billing cycle was skipped. * source​Contract [Subscription​Contract!](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionContract) non-null The subscription contract that the billing cycle belongs to. * status [Subscription​Billing​Cycle​Billing​Cycle​Status!](https://shopify.dev/docs/api/admin-graphql/unstable/enums/SubscriptionBillingCycleBillingCycleStatus) non-null The status of the billing cycle. *** ## Map ### Fields and connections with this object * <->[SubscriptionBillingCycleConnection.nodes](https://shopify.dev/docs/api/admin-graphql/unstable/connections/SubscriptionBillingCycleConnection#returns-nodes) * {}[SubscriptionBillingCycleEdge.node](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingCycleEdge#field-SubscriptionBillingCycleEdge.fields.node) * {}[SubscriptionBillingCycleEditedContract.billingCycles](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingCycleEditedContract#field-SubscriptionBillingCycleEditedContract.fields.billingCycles) * {}[SubscriptionDraft.billingCycle](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionDraft#field-SubscriptionDraft.fields.billingCycle) * {}[SubscriptionDraft.concatenatedBillingCycles](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionDraft#field-SubscriptionDraft.fields.concatenatedBillingCycles) *** ## Queries * [subscription​Billing​Cycle](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycle) query Returns a subscription billing cycle found either by cycle index or date. * billing​Cycle​Input [Subscription​Billing​Cycle​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleInput) required ### Arguments Input object used to select and use billing cycles. *** * [subscription​Billing​Cycle​Bulk​Results](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycleBulkResults) query Retrieves the results of the asynchronous job for the subscription billing cycle bulk action based on the specified job ID. This query can be used to obtain the billing cycles that match the criteria defined in the subscriptionBillingCycleBulkSearch and subscriptionBillingCycleBulkCharge mutations. * job​Id [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID) required ### Arguments The ID of the billing cycle bulk operation job. * first [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * [subscription​Billing​Cycles](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycles) query Returns subscription billing cycles for a contract ID. * contract​Id [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID) required ### Arguments The ID of the subscription contract to retrieve billing cycles for. * billing​Cycles​Date​Range​Selector [Subscription​Billing​Cycles​Date​Range​Selector](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCyclesDateRangeSelector) Select subscription billing cycles within a date range. * billing​Cycles​Index​Range​Selector [Subscription​Billing​Cycles​Index​Range​Selector](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCyclesIndexRangeSelector) Select subscription billing cycles within an index range. * first [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Subscription​Billing​Cycles​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/unstable/enums/SubscriptionBillingCyclesSortKeys) Default:CYCLE\_INDEX Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). *** *** ## \SubscriptionBillingCycle Queries ### Queried by * \[subscription​Billing​Cycle](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycle) * \[subscription​Billing​Cycle​Bulk​Results](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycleBulkResults) * \[subscription​Billing​Cycles](https://shopify.dev/docs/api/admin-graphql/unstable/queries/subscriptionBillingCycles) *** ## Mutations * [subscription​Billing​Cycle​Edit​Delete](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleEditDelete) mutation Delete the schedule and contract edits of the selected subscription billing cycle. * billing​Cycle​Input [Subscription​Billing​Cycle​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleInput) required ### Arguments Input object used to select and use billing cycles. *** * [subscription​Billing​Cycle​Edits​Delete](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleEditsDelete) mutation Delete the current and future schedule and contract edits of a list of subscription billing cycles. * contract​Id [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID) required ### Arguments The globally-unique identifier of the subscription contract that the billing cycle belongs to. * target​Selection [Subscription​Billing​Cycles​Target​Selection!](https://shopify.dev/docs/api/admin-graphql/unstable/enums/SubscriptionBillingCyclesTargetSelection) required Select billing cycles to be deleted. *** * [subscription​Billing​Cycle​Schedule​Edit](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleScheduleEdit) mutation Modify the schedule of a specific billing cycle. * billing​Cycle​Input [Subscription​Billing​Cycle​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleInput) required ### Arguments Input object for selecting and using billing cycles. * input [Subscription​Billing​Cycle​Schedule​Edit​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleScheduleEditInput) required Data used to create or modify billing cycle schedule edit. *** * [subscription​Billing​Cycle​Skip](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleSkip) mutation Skips a Subscription Billing Cycle. * billing​Cycle​Input [Subscription​Billing​Cycle​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleInput) required ### Arguments Input object for selecting and using billing cycles. *** * [subscription​Billing​Cycle​Unskip](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleUnskip) mutation Unskips a Subscription Billing Cycle. * billing​Cycle​Input [Subscription​Billing​Cycle​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/SubscriptionBillingCycleInput) required ### Arguments Input object for selecting and using billing cycles. *** *** ## <\~> SubscriptionBillingCycle Mutations ### Mutated by * <\~>[subscription​Billing​Cycle​Edit​Delete](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleEditDelete) * <\~>[subscription​Billing​Cycle​Edits​Delete](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleEditsDelete) * <\~>[subscription​Billing​Cycle​Schedule​Edit](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleScheduleEdit) * <\~>[subscription​Billing​Cycle​Skip](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleSkip) * <\~>[subscription​Billing​Cycle​Unskip](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/subscriptionBillingCycleUnskip)