Subscription
Requires the or scope.
A subscription billing cycle.
Anchor to Fields and connectionsFields and connections
- 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 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
- •query
Returns a subscription billing cycle found either by cycle index or date.
- •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.
- •query
Returns subscription billing cycles for a contract ID.
Anchor to MutationsMutations
- •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
- Anchor to billingCyclesbilling•[Subscription
Cycles Billing Cycle!] The list of updated billing cycles.
- Anchor to userErrorsuser•[Subscription
Errors Billing Cycle User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to billingCyclesbilling•[Subscription
Cycles Billing Cycle!] The list of updated billing cycles.
- Anchor to userErrorsuser•[Subscription
Errors Billing Cycle User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to billingCyclebilling•Subscription
Cycle Billing Cycle The updated billing cycle.
- Anchor to userErrorsuser•[Subscription
Errors Billing Cycle User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to billingCyclebilling•Subscription
Cycle Billing Cycle The updated billing cycle.
- Anchor to userErrorsuser•[Subscription
Errors Billing Cycle Skip User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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
- Anchor to billingCyclebilling•Subscription
Cycle Billing Cycle The updated billing cycle.
- Anchor to userErrorsuser•[Subscription
Errors Billing Cycle Unskip User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields