ChargebeeAPI

Change billing date

Idempotency Supported
Try in API Explorer

Applicable when calendar billing (with customer specific billing date support) is enabled. Changes the customer's billing_date and/or billing_day_of_week.

During this operation the upcoming renewal dates are not updated to align immediately with the new date. The alignment will happen during subsequent renewals. For example, a customer's upcoming renewal is scheduled for January 10th, when the customer's billing date is changed to the 15th, the next renewal date is still January 10th. The new billing date does not take effect until the subsequent renewal, which in this case is February 15th. If you want to align with the new date immediately (in this example: you want the next renewal to be on January 15th and not January 10th) you need to manually change the subscription's term end.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/customers/{customer-id}/change_billing_date

Input Parameters

billing_date
optional, integer, min=1, max=31

Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the monthly and yearly subscriptions of this customer will be aligned to this date.

billing_month
optional, integer, min=1, max=12

billing_month, together with billing_date, specify, for this customer, the day of the year when the renewals of all the year-based subscriptions take place.

For example, the renewals happen on 15th July when billing_month is 7 and billing_date is 15.

Note Applicable when Calendar Billing (with customer-specific billing date support) is enabled and billing_date_mode is manually_set.

billing_date_mode
optional, enumerated string

Indicates whether this customer's billing_date value is derived as per configurations or its specifically set (overriden). When specifically set, the billing_date will not be reset even when all of the monthly/yearly subscriptions are cancelled.

Possible Enum Values
using_defaults

Billing date is set based on defaults configured.

manually_set

Billing date is specifically set (default configuration is overridden)

billing_day_of_week
optional, enumerated string

Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day.

Possible Enum Values
sunday

Sunday

monday

Monday

tuesday

Tuesday

wednesday

Wednesday

thursday

Thursday

friday

Friday

saturday

Saturday

billing_day_of_week_mode
optional, enumerated string

Indicates whether this customer's billing_day_of_week value is derived as per configurations or its specifically set (overriden). When specifically set, the billing_day_of_week will not be reset even when all of the weekly subscriptions are cancelled.

Possible Enum Values
using_defaults

Billing date is set based on defaults configured.

manually_set

Billing date is specifically set (default configuration is overridden)

Returns

customerCustomer object

Resource object representing customer