POST /payment_schedule_schemes

Creates a payment schedule scheme. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.

Servers

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

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
`period_unit`	String	Yes	Defines the time unit for intervals between payment schedules. Possible values are: day, week, and month. * month - When the time unit for intervals between payment schedules is set as month * week - When the time unit for intervals between payment schedules is set as week * day - When the time unit for intervals between payment schedules is set as day Possible values: `"month"` `"day"` `"week"`
`name`	String	Yes	The name of a payment schedule scheme.
`flexible_schedules`	Object	No	Parameters for flexible_schedules
`flexible_schedules.period[]`	Array	No	The interval after which this payment schedule should be collected.
`flexible_schedules.amount_percentage[]`	Array	No	The percentage amount that this specific payment schedule should collect.
`period`	Integer	No	The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum `period` varies based on the `period_unit`: Day: Up to 30 days Week: Up to 6 weeks Month: Up to 6 months
`number_of_schedules`	Integer	Yes	Specifies the total number of payment schedules for the invoice. The maximum `number_of_schedules` varies based on the `period_unit`: Day: Up to 30 schedules Week: Up to 52 schedules Month: Up to 12 schedules

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.