Creates a new subscription plan for managing subscription payments.
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.
JSON object containing recurring plan details.
Merchant-provided identifier for the recurring plan.
Xendit-generated customer ID.
The type of action requested for the recurring plan.
ISO 4217 currency code (e.g., IDR, PHP).
Amount to be charged in each recurring cycle.
Merchant-provided identifier for the schedule.
Frequency of the recurring cycles.
Number of intervals between consecutive cycles.
Total number of cycles (optional; runs indefinitely if null).
Start date for the recurring schedule (ISO 8601 format).
Interval between retry attempts for failed payments.
Number of retry intervals between consecutive retries.
Maximum number of retries for failed cycles.
Notifications triggered at specific retry attempts.
Array of payment methods that the recurring plan will attempt to make payments with.
ID for payment method generated by the Create Payment Method API.
Order in which payment methods will be attempted (1 to 5).
Action taken upon recurring plan creation. Failing the action will inactivate the plan.
Notification preferences for the recurring plan.
Channels to notify the customer when the plan is created.
Channels to notify the customer when a cycle succeeds.
Channels to notify the customer when a cycle fails.
Language of notifications sent to the end user.
Whether a payment link is generated for failed cycle attempts.
Behavior when recurring cycles fail. RESUME continues, STOP inactivates the plan.
Additional information provided by the merchant.
Description of the recurring plan, displayed to customers.
Details of items included in the recurring plan.
Type of item.
Name of the item.
Net amount charged per unit. Negative values for discounts.
Number of units of the item.
URL of the item.
Merchant category for the item.
Subcategory for the item.
Description of the item.
Additional item attributes.
URL where the end user is redirected after successful account linking. Required when payment_method_id is not provided.
URL where the end user is redirected if account linking fails. Required when payment_method_id is not provided.
Successfully created a recurring plan. A webhook will follow to confirm plan activation.
Merchant-provided identifier for the recurring plan.
Xendit-generated customer ID.
The type of action requested for the recurring plan.
ISO 4217 currency code (e.g., IDR, PHP).
Amount to be charged in each recurring cycle.
Merchant-provided identifier for the schedule.
Frequency of the recurring cycles.
Number of intervals between consecutive cycles.
Total number of cycles (optional; runs indefinitely if null).
Start date for the recurring schedule (ISO 8601 format).
Interval between retry attempts for failed payments.
Number of retry intervals between consecutive retries.
Maximum number of retries for failed cycles.
Notifications triggered at specific retry attempts.
Array of payment methods that the recurring plan will attempt to make payments with.
ID for payment method generated by the Create Payment Method API.
Order in which payment methods will be attempted (1 to 5).
Action taken upon recurring plan creation. Failing the action will inactivate the plan.
Notification preferences for the recurring plan.
Channels to notify the customer when the plan is created.
Channels to notify the customer when a cycle succeeds.
Channels to notify the customer when a cycle fails.
Language of notifications sent to the end user.
Whether a payment link is generated for failed cycle attempts.
Behavior when recurring cycles fail. RESUME continues, STOP inactivates the plan.
Additional information provided by the merchant.
Description of the recurring plan, displayed to customers.
Details of items included in the recurring plan.
Type of item.
Name of the item.
Net amount charged per unit. Negative values for discounts.
Number of units of the item.
URL of the item.
Merchant category for the item.
Subcategory for the item.
Description of the item.
Additional item attributes.
URL where the end user is redirected after successful account linking. Required when payment_method_id is not provided.
URL where the end user is redirected if account linking fails. Required when payment_method_id is not provided.
Xendit-generated recurring plan ID.
Status of the recurring plan.
Array of objects containing URLs for end users to complete the recurring plan.
Describes the purpose of the action. AUTH triggers payment account linking.
Type of URL, optimized for desktop or web interface.
Generated URL to perform the action.
HTTP method for calling the URL.
Validation errors occurred.
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."
}Payment method ID is not in eligible status for plan creation.
{
"error_code": "INVALID_PAYMENT_METHOD_ID",
"message": "The payment_method_id provided has a mismatched currency or it is not \"ACTIVE\" because it has expired/ been unlinked/ linking has not been completed. Please retry with a valid payment_method_id."
}Error code identifying the issue.
Description of the error.
Invalid API key or unauthorized access.
Resource not found.
Customer not found.
{
"error_code": "CUSTOMER_NOT_FOUND",
"message": "customer_id is invalid or not found. Please try again with a valid customer_id."
}Payment method not found.
{
"error_code": "PAYMENT_METHOD_ID_NOT_FOUND",
"message": "The payment_method_id provided is not found. Please retry with a valid payment_method_id."
}Unsupported content type.
Server error.
Recurring plan webhook
Recurring plan webhook to indentify status transition of plan
Webhook event names for recurring plan status updates.
Business ID of Xendit
Timestamp of webhook delivery attempt in ISO 8601 date-time format.
Merchant-provided identifier for the recurring plan.
Xendit-generated customer ID.
The type of action requested for the recurring plan.
ISO 4217 currency code (e.g., IDR, PHP).
Amount to be charged in each recurring cycle.
Merchant-provided identifier for the schedule.
Frequency of the recurring cycles.
Number of intervals between consecutive cycles.
Total number of cycles (optional; runs indefinitely if null).
Start date for the recurring schedule (ISO 8601 format).
Interval between retry attempts for failed payments.
Number of retry intervals between consecutive retries.
Maximum number of retries for failed cycles.
Notifications triggered at specific retry attempts.
Array of payment methods that the recurring plan will attempt to make payments with.
ID for payment method generated by the Create Payment Method API.
Order in which payment methods will be attempted (1 to 5).
Action taken upon recurring plan creation. Failing the action will inactivate the plan.
Notification preferences for the recurring plan.
Channels to notify the customer when the plan is created.
Channels to notify the customer when a cycle succeeds.
Channels to notify the customer when a cycle fails.
Language of notifications sent to the end user.
Whether a payment link is generated for failed cycle attempts.
Behavior when recurring cycles fail. RESUME continues, STOP inactivates the plan.
Additional information provided by the merchant.
Description of the recurring plan, displayed to customers.
Details of items included in the recurring plan.
Type of item.
Name of the item.
Net amount charged per unit. Negative values for discounts.
Number of units of the item.
URL of the item.
Merchant category for the item.
Subcategory for the item.
Description of the item.
Additional item attributes.
URL where the end user is redirected after successful account linking. Required when payment_method_id is not provided.
URL where the end user is redirected if account linking fails. Required when payment_method_id is not provided.
Xendit-generated recurring plan ID.
Status of the recurring plan.
Array of objects containing URLs for end users to complete the recurring plan.
Describes the purpose of the action. AUTH triggers payment account linking.
Type of URL, optimized for desktop or web interface.
Generated URL to perform the action.
HTTP method for calling the URL.
OK