Retrieves details of a specific subscription cycle by its ID.
The sub-account user-id to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.
The XenPlatform split rule ID that will be applied to this transaction. This header is only used if you have access to xenPlatform.
The ID of the recurring plan.
The ID of the recurring cycle.
Successfully retrieved the recurring cycle.
Xendit-generated recurring cycle ID.
Indicates whether the cycle was charged as part of plan creation
Inherited from Plan reference_id
ID of the associated recurring plan.
Xendit-generated customer ID.
The order of the current cycle within the plan
Status of the recurring cycle.
Details of any attempt actions made on the cycle.
Order of the attempt within the cycle. The current action belongs to this attempt.
Order of the action within an attempt. An attempt can have multiple actions. In general, one action corresponds to one unique payment token within the same attempt.
The type of payment attempt made on the cycle. INITIAL represents the first system generated attempt on the cycle. RETRY represents all subsequent system generated attempt after first attempt failed. FORCED represents explicit request made by the merchant to perform a payment attempt on the cycle. PAYMENT_LINK represents a payment link sent to the end user to solicit payment.
The date time that the payment action was performed.
This field used to indicate the payment ID created from cycle
The payment token ID used for this payment action.
The status of the action
If payment action encounters an error, the failure reason will be shown here.
The date time that the next RETRY attempt should be created for this cycle.
Contains details of payment links sent to the end user.
Payment session id created when the cycle attempt failed
This URL will lead the end user to a checkout page to complete the payment.
number of attempts made on the cycle so far
number of forced attempts made on the cycle so far
The scheduled date and time that the cycle will be executed. Always in UTC zero.
ISO 4217 currency code (e.g., IDR, PHP).
Amount charged in the cycle.
ISO 8601 date time format
ISO 8601 date time format
Validation errors occurred. Safe to retry.
Fields or values in the payload body does not comply with our API specification.
{
"error_code": "API_VALIDATION_ERROR",
"message": "Check the specific error message for debugging."
}Error code identifying the issue.
Description of the error.
Invalid API key or unauthorized access. Safe to retry.
Request forbidden error. Safe to retry.
Resource not found. Safe to retry.
Cycle not found.
{
"error_code": "DATA_NOT_FOUND",
"message": "Recurring cycle_id not found. Please check your query again."
}Server error.
Recurring cycle webhook
Recurring cycle webhook to indentify status transition of plan
Webhook event names for recurring cycle status updates.
Business ID of Xendit
Timestamp of webhook delivery attempt in ISO 8601 date-time format.
Xendit-generated recurring cycle ID.
Indicates whether the cycle was charged as part of plan creation
Inherited from Plan reference_id
ID of the associated recurring plan.
Xendit-generated customer ID.
The order of the current cycle within the plan
Status of the recurring cycle.
Details of any attempt actions made on the cycle.
Order of the attempt within the cycle. The current action belongs to this attempt.
Order of the action within an attempt. An attempt can have multiple actions. In general, one action corresponds to one unique payment token within the same attempt.
The type of payment attempt made on the cycle. INITIAL represents the first system generated attempt on the cycle. RETRY represents all subsequent system generated attempt after first attempt failed. FORCED represents explicit request made by the merchant to perform a payment attempt on the cycle. PAYMENT_LINK represents a payment link sent to the end user to solicit payment.
The date time that the payment action was performed.
This field used to indicate the payment ID created from cycle
The payment token ID used for this payment action.
The status of the action
If payment action encounters an error, the failure reason will be shown here.
The date time that the next RETRY attempt should be created for this cycle.
Contains details of payment links sent to the end user.
Payment session id created when the cycle attempt failed
This URL will lead the end user to a checkout page to complete the payment.
number of attempts made on the cycle so far
number of forced attempts made on the cycle so far
The scheduled date and time that the cycle will be executed. Always in UTC zero.
ISO 4217 currency code (e.g., IDR, PHP).
Amount charged in the cycle.
ISO 8601 date time format
ISO 8601 date time format
OK