Subscription
Requires the or scope.
A subscription billing cycle.
Anchor to FieldsFields
- billingAttemptExpectedDate (DateTime!)
- billingAttempts (SubscriptionBillingAttemptConnection!)
- cycleEndAt (DateTime!)
- cycleIndex (Int!)
- cycleStartAt (DateTime!)
- edited (Boolean!)
- editedContract (SubscriptionBillingCycleEditedContract)
- skipped (Boolean!)
- sourceContract (SubscriptionContract!)
- status (SubscriptionBillingCycleBillingCycleStatus!)
- Anchor to billingAttemptExpectedDatebilling•Date
Attempt Expected Date Time! non-null The date on which the billing attempt is expected to be made.
- Anchor to billingAttemptsbilling•Subscription
Attempts Billing Attempt Connection! non-null The list of billing attempts associated with the billing cycle.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to cycleEndAtcycle•Date
End At Time! non-null The end date of the billing cycle.
- Anchor to cycleIndexcycle•Int!
Index non-null The index of the billing cycle.
- Anchor to cycleStartAtcycle•Date
Start At Time! non-null The start date of the billing cycle.
- Anchor to editededited•Boolean!non-null
Whether this billing cycle was edited.
- Anchor to editedContractedited•Subscription
Contract Billing Cycle Edited Contract The active edited contract for the billing cycle.
- Anchor to skippedskipped•Boolean!non-null
Whether this billing cycle was skipped.
- Anchor to sourceContractsource•Subscription
Contract Contract! non-null The subscription contract that the billing cycle belongs to.
- Anchor to statusstatus•Subscription
Billing Cycle Billing Cycle Status! non-null The status of the billing cycle.
Anchor to QueriesQueries
- subscriptionBillingCycle (SubscriptionBillingCycle)
- subscriptionBillingCycleBulkResults (SubscriptionBillingCycleConnection!)
- subscriptionBillingCycles (SubscriptionBillingCycleConnection!)
- •query
Returns a subscription billing cycle found either by cycle index or date.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object used to select and use billing cycles.
Arguments
- •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.
- Anchor to jobIdjob•ID!
Id required The ID of the billing cycle bulk operation job.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •query
Returns subscription billing cycles for a contract ID.
- Anchor to contractIdcontract•ID!
Id required The ID of the subscription contract to retrieve billing cycles for.
- Anchor to billingCyclesDateRangeSelectorbilling•Subscription
Cycles Date Range Selector Billing Cycles Date Range Selector Select subscription billing cycles within a date range.
- Anchor to billingCyclesIndexRangeSelectorbilling•Subscription
Cycles Index Range Selector Billing Cycles Index Range Selector Select subscription billing cycles within an index range.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Subscription
Key Billing Cycles Sort Keys 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.
Arguments
Anchor to MutationsMutations
- subscriptionBillingCycleEditDelete (SubscriptionBillingCycleEditDeletePayload)
- subscriptionBillingCycleEditsDelete (SubscriptionBillingCycleEditsDeletePayload)
- subscriptionBillingCycleScheduleEdit (SubscriptionBillingCycleScheduleEditPayload)
- subscriptionBillingCycleSkip (SubscriptionBillingCycleSkipPayload)
- subscriptionBillingCycleUnskip (SubscriptionBillingCycleUnskipPayload)
- •mutation
Delete the schedule and contract edits of the selected subscription billing cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object used to select and use billing cycles.
Arguments
- •mutation
Delete the current and future schedule and contract edits of a list of subscription billing cycles.
- Anchor to contractIdcontract•ID!
Id required The globally-unique identifier of the subscription contract that the billing cycle belongs to.
- Anchor to targetSelectiontarget•Subscription
Selection Billing Cycles Target Selection! required Select billing cycles to be deleted.
Arguments
- •mutation
Modify the schedule of a specific billing cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object for selecting and using billing cycles.
- Anchor to inputinput•Subscription
Billing Cycle Schedule Edit Input! required Data used to create or modify billing cycle schedule edit.
Arguments
- •mutation
Skips a Subscription Billing Cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object for selecting and using billing cycles.
Arguments
- •mutation
Unskips a Subscription Billing Cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object for selecting and using billing cycles.
Arguments