postponeEndDate( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Extends the duration of a pricing plan order by postponing the order's endDate.

The postponeEndDate() function returns a Promise that resolves when the order's end date is successfully changed.

The new end date and time must be later than the order's current endDate.

Postponing the end date of an order does not impact payments. For example, if the pricing plan is for a membership to an online lecture series, and you want to extend the duration of the series because the lecturer could not attend some sessions, you can postpone the end date of the orders for all relevant participants. The participants will not be billed additionally.

Postponing an order causes the following changes:

  • The endDate for the order is adjusted to the new end date.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.


endDateRequired

New end date and time.

Must be later than the current end date and time.

Was this helpful?
Yes
No