Function CheckoutSessionsApiFactory

Returns {
    createCheckoutSession(requestParameters, options?) => AxiosPromise<CheckoutSession>;
    expireCheckoutSession(requestParameters, options?) => AxiosPromise<CheckoutSession>;
    getCheckoutSession(requestParameters, options?) => AxiosPromise<CheckoutSession>;
    listCheckoutSessions(requestParameters, options?) => AxiosPromise<ListCheckoutSessions200Response>;
}

• createCheckoutSession:function

  • createCheckoutSession(requestParameters, options?): AxiosPromise<CheckoutSession>

  • Creates a Checkout Session.

    Summary

    Create a Checkout Session

    Throws

    Parameters

    • requestParameters: CheckoutSessionsApiCreateCheckoutSessionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CheckoutSession>

• expireCheckoutSession:function

  • expireCheckoutSession(requestParameters, options?): AxiosPromise<CheckoutSession>

  • Expires a Checkout Session. A Checkout Session can only be expired if its status is open. Once expired, the customer cannot complete the Checkout Session and will see a message about the expiration.

    Summary

    Expire a Checkout Session

    Throws

    Parameters

    • requestParameters: CheckoutSessionsApiExpireCheckoutSessionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CheckoutSession>

• getCheckoutSession:function

  • getCheckoutSession(requestParameters, options?): AxiosPromise<CheckoutSession>

  • Retrieves the details of an existing Checkout Session.

    Summary

    Get a Checkout Session

    Throws

    Parameters

    • requestParameters: CheckoutSessionsApiGetCheckoutSessionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CheckoutSession>

• listCheckoutSessions:function

  • listCheckoutSessions(requestParameters, options?): AxiosPromise<ListCheckoutSessions200Response>

  • Returns a list of Checkout Sessions. The Checkout Sessions are sorted with the most recently created Checkout Session appearing first.

    Summary

    List all Checkout Sessions

    Throws

    Parameters

    • requestParameters: CheckoutSessionsApiListCheckoutSessionsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListCheckoutSessions200Response>