_idstring required
The ID of the subscription cycle
namestring required
The name of the subscription cycle
status'DRAFT' | 'SCHEDULED' | 'ACTIVE' | 'COMPLETED' required
The status of the subscription cycle
action'extension' | 'renewal' | 'status-change' required
The action of the subscription cycle
planIdstring required
The ID of the plan of the subscription cycle
planVariantIdsstring[] required
The ID of the plan variant of the subscription cycle
eventIdstring required
The ID of the event of the subscription cycle
billingobject nullable
The billing of the subscription cycle
sellerIdstring required
The ID of the seller of the subscription cycle
createdAtstring date-time required
An ISO timestamp indicating when the cycle was created
updatedAtstring date-time required
An ISO timestamp indicating when the cycle was created
startedAtstring date-time
An ISO timestamp indicating when the cycle was created
finishedAtstring date-time
An ISO timestamp indicating when the cycle was created
subscriptionsAffectednumber float
Amount of affected subscription after cycle applied
subscriptionFilterobject
The subscription filters to apply to the subscriptions in the cycle. This is used to filter subscriptions that should be affected by the cycle