Checkout a plan

Checkout and checkout summary endpoints allow you to create a new order or get a preview of an order.
Depending on the organization settings and purchase flows and the current member status they may create an invoice, charge the member and send an invoice automatically. They should be called with a token issued with member credentials (using the auth/signin endpoint) and not with an integration key and secret.

Here is the list of all properties the checkout request object has:

Checkout Request

PropertyTypeRequiredDescription
plansPlanRequestfalseA list of plan request definitions to be added to the order.
feesFeeRequestfalseA list of fee request definitions to be added to the order.
discountCodes[string]false0 or 1 discount codes to be applied.
officeidfalseThe _id of the location for which the checkout request will be executed. If left empty the default location of the member (or the company if the member is part of one) will be used.

Plan Request

PropertyTypeRequiredDescription
planidtrueThe ID of the membership plan to be ordered.
startDatedatetrueThe start date of the ordered membership.
endDatedatefalseThe end date of the ordered membership.

Fee Request

PropertyTypeRequiredDescription
planidtrueThe ID of the membership plan to be ordered.
datedatetrueThe date the one-off is ordered for.

Option 1 - Create a checkout request with at least one recurring plans.
You can add non-recurring fees as well.

Option 2- Create a checkout request with at least one non-recurring fee.
You can add recurring plans as well.

Language
Authorization
OAuth2
URL
Click Try It! to start a request and see the response here!