POST /subscriptions/{subscription-id}/edit_advance_invoice_schedule

Caution

This API cannot be used for subscriptions that have ramps.

This API will return an error when multi-frequency billing is enabled.

Modifies the advance invoicing schedule for a subscription.

Servers

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

Path parameters

Name	Type	Required	Description
`subscription-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 Possible 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 Possible 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 Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`fixed_interval_schedule`	Object	No	Parameters for fixed_interval_schedule
`fixed_interval_schedule.end_date`	Integer	No	The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when `fixed_interval_schedule[end_schedule_on]` = `specific_date`.
`fixed_interval_schedule.days_before_renewal`	Integer	No	The number of days before each interval that advance invoices are generated.
`fixed_interval_schedule.number_of_occurrences`	Integer	No	The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the `remaining_billing_cycles` of the subscription. This parameter is applicable only when `fixed_interval_schedule[end_schedule_on]` = `after_number_of_intervals`
`fixed_interval_schedule.end_schedule_on`	String	No	Specifies when the schedule should end. * after_number_of_intervals - Advance invoices are generated a `specified number of times` * subscription_end - Advance invoices are generated for as long as the subscription is active. * specific_date - End the advance invoicing schedule on a `specific date`. Possible values: `"after_number_of_intervals"` `"subscription_end"` `"specific_date"`
`specific_dates_schedule`	Object	No	Parameters for specific_dates_schedule
`specific_dates_schedule.id[]`	Array	No	The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.
`specific_dates_schedule.terms_to_charge[]`	Array	No	The number of billing cycles to charge for, on the date specified. Applicable only when `schedule_type` is specific_dates.
`specific_dates_schedule.date[]`	Array	No	The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when `schedule_type` is `specific_dates`.
`schedule_type`	String	No	The type of advance invoice or advance invoicing schedule. * specific_dates - Charge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured. * fixed_intervals - Charge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end. Possible values: `"fixed_intervals"` `"specific_dates"`
`terms_to_charge`	Integer	No	The number of billing cycles in one interval.

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.