For archived content, access the previous documentation here or the previous API reference here.

Update Subscription Cycle

  • Updated on Jul 24, 2025
  • Published on Dec 4, 2024
Prev Next
Patch
/recurring/plans/{plan_id}/cycles/{id}

Updates a specific subscription cycle by its ID.

Header parameters
for-user-id
string

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.

Path parameters
plan_id
stringRequired

Xendit-generated recurring plan ID, with prefix repl-xxx

id
stringRequired

Xendit-generated recurring cycle ID, with prefix recy-xxx

Body parameters

JSON object containing fields to update in the recurring cycle.

object
scheduled_timestamp
string

ISO 8601 Timestamp (e.g. "2020-04-20T00:00:00Z" UTC+0) for the upcoming action attempt for the recurring cycle - value is updated on each retry (if any). Action will be executed within 24 hours of the scheduled timestamp with timezone taken into consideration.

currency
string

ISO 4217 currency code of subscription plan

amount
string

Amount that recurring plan will charge to end users. Recurring cycles will be generated based on this value. If items param is used, amount should be equivalent to the sum of net_unit_amount multiplied by quantity in the items array

Responses
200

Successfully retrieved the recurring cycle.

object
id
string

Xendit-generated recurring cycle ID.

plan_id
string

ID of the associated recurring plan.

status
string

Status of the recurring cycle.

Valid values[ "PENDING", "RETRYING", "FAILED", "SUCCEEDED" ]
amount
number

Amount charged in the cycle.

400

Validation errors occurred. Safe to retry.

API_VALIDATION_ERROR

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."
}
object
error_code
string

Error code identifying the issue.

message
string

Description of the error.

401

Invalid API key or unauthorized access. Safe to retry.

object
Example{ "error_code": "INVALID_API_KEY", "message": "API key format is invalid." }
error_code
string
message
string
404

Resource not found. Safe to retry.

DATA_NOT_FOUND

Customer not found.

{
  "error_code": "DATA_NOT_FOUND",
  "message": "Recurring cycle_id not found. Please check your query again."
}
object
error_code
string
message
string
415

Unsupported content type. Safe to retry.

object
Example{ "error_code": "UNSUPPORTED_CONTENT_TYPE", "message": "The content type requested is not supported." }
error_code
string
message
string
500

Server error.

object
Example{ "error_code": "SERVER_ERROR", "message": "An unexpected error occurred. Our team has been notified and will troubleshoot the issue." }
error_code
string
message
string