Manually renew an existing subscription by generating a new recurring invoice and payment.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Manually renew an existing subscription by generating a new recurring invoice and payment.
Optional. Whether to apply available promo credit to this renewal invoice.
Optional. Maximum promo credit amount to apply. If omitted and applyPromoCredit is true, the system auto-computes the usable amount.
Optional. URL to redirect the customer to when the renewal payment is cancelled or fails.
Optional. Discount or coupon code applied only to this renewal. Overrides the subscription's recurring discount for this invoice.
Optional. Payment gateway ID used for the renewal invoice. If omitted, the subscription's original gateway configuration is used.
Optional. Payment type for the selected gateway, such as card, wallet, etc.
Optional. If true, do not create an automatic payment for the renewal invoice; the invoice will be created in open status for manual collection.
Optional. Custom metadata map that will be stored on the renewal invoice and subscription timeline.
Optional. Checkout UI mode: hosted | embedded | custom. Default is hosted.
Optional. Product ID used together with userId when subscriptionId is not specified, to narrow down which subscription to renew. If 0, the system uses its default product selection rules.
Optional. URL to redirect the customer to after successful renewal or payment completion.
Optional. SubscriptionId to be renewed. Either subscriptionId or userId must be provided. When subscriptionId is omitted, the system first tries to find the latest active or incomplete subscription for the user (and productId if provided), otherwise falls back to the latest subscription.
Optional. External tax percentage override for the renewal invoice, in basis points (e.g. 1000 = 10%%). Overrides the subscription taxPercentage when provided.
Optional. UserId associated with the subscription to renew. Either subscriptionId or userId must be provided. Used to locate the target subscription when subscriptionId is not provided.