POST /customers/{customer-id}/change_billing_date

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.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`customer-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Valid values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Valid values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
`chargebee-event-email`	String	No	skip only emails Valid values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`billing_month`	Integer	No	`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`	Integer	No	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_date_mode`	String	No	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. * manually_set - Billing date is specifically set (default configuration is overridden) * using_defaults - Billing date is set based on defaults configured. Valid values: `"using_defaults"` `"manually_set"`
`billing_day_of_week`	String	No	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. * sunday - Sunday * wednesday - Wednesday * tuesday - Tuesday * monday - Monday * saturday - Saturday * friday - Friday * thursday - Thursday Valid values: `"tuesday"` `"friday"` `"thursday"` `"monday"` `"saturday"` `"sunday"` `"wednesday"`
`billing_day_of_week_mode`	String	No	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. * manually_set - Billing date is specifically set (default configuration is overridden) * using_defaults - Billing date is set based on defaults configured. Valid values: `"using_defaults"` `"manually_set"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.