POST /subscriptions/{subscription-id}/pause_subscription_estimate

This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date and resume_date. This is similar to the Pause a subscription API with the exception that the subscription is not paused. Only an estimate for this operation is created.

In the response,

estimate.subscription_estimate has the subscription details.
estimate.invoice_estimate has details of the invoice that are generated immediately. This is not present if no immediate invoices are generated for this operation.
estimate.credit_note_estimates[] has details of the credit notes that are generated during this operation. This list is empty if no credit notes are generated.

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
`subscription`	Object	No	Parameters for subscription
`subscription.skip_billing_cycles`	Integer	No	Number of billing cycles this subscription should be paused. The subscription resumes after the paused billing cycles end.
`subscription.pause_date`	Integer	No	When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the `paused` state, it is the date/time when the subscription was paused.
`subscription.resume_date`	Integer	No	For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
`pause_option`	String	No	List of options to pause the subscription. * billing_cycles - Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in skip_billing_cycles * immediately - Pause immediately * end_of_term - Pause at the end of current term * specific_date - Pause on a specific date Possible values: `"end_of_term"` `"immediately"` `"billing_cycles"` `"specific_date"`
`unbilled_charges_handling`	String	No	Applicable when unbilled charges are present for the subscription and pause_option is set as `immediately`. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to `on`. * invoice - Invoice charges If `invoice` is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid. * no_action - Retain as unbilled If `no_action` is chosen, charges are added to the resumption invoice. Possible values: `"no_action"` `"invoice"`

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.