Payment Method Details
Change the Subscription’s billing day
Change the standard billing day of the month assigned to a subscription. Commonly referred to as the “anniversary day” or “billing day” - this value is an integer between 1 and 31 representing which day of the month is used for any recurring billing based on some number of months in term. While not meaningful for subscriptions whose plan includes daily, weekly, or mixed term period lengths, it is a useful predictor often shared with customers for monthly, quarterly, and annual plans (e.g. billed on the 1st of every month; billed on the 1st of January every year, etc.)
This operation supports changing the billing day temporarily or permanently. Note: moving the billing day of an active subscription forward can have the effect of granting extra time as proration is not automatically added when the pre-paid billing period is extended.
by_days are mutually exclusive methods for moving a next billing day in conjunction with the option to make the change permanent (
Route (URL) Parameters
|subscription||n/a||The id or the vid of the Subscription to retrieve||Yes|
|to_date||n/a||Date for the next billing (when moving the subscription to bill on a new, specific date)||No|
|to_day||n/a||Integer value (1 - 31) to assign as the next “billing day” for the subscription moving the next billing to that day in the same calendar month in which it was scheduled; when used with ‘perm’ parameter this will become the new billing day permanently.||No|
|by_days||n/a||Integer specify the number of days from the current next billing to delay; when used with 'perm’ parameter this will become the new billing day permanently.||No|
|perm||false||Boolean: Indicates whether the change should be permanent (true) or just apply to the next billing (false).|
JOSN A full Subscription object representing the resulting changes.