POST /subscriptions/{subscription-id}/advance_invoice_estimate

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Valid values:

• "all-disabled"

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.

skip all actions to be done on the events

Valid values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

skip only emails

Valid values:

• "all-disabled"

Parameters for fixed_interval_schedule

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.

The number of days before each interval that advance invoices are generated.

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

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.

Valid values:

• "after_number_of_intervals"
• "subscription_end"
• "specific_date"

Whether the charge should be invoiced immediately or added to unbilled_charges. Applicable only when schedule_type is immediate.

Parameters for specific_dates_schedule

The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type is specific_dates.

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.

The type of advance invoice or advance invoicing schedule.

• immediate - Charge immediately for the number of billing cycles specified by terms_to_charge.
• 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.

Valid values:

• "fixed_intervals"
• "immediate"
• "specific_dates"

• For schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.
• For schedule_type = fixed_intervals: The number of future billing cycles in one interval. 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.

Default value: 1