Function CheckoutSessionsApiFp

Returns {
    createCheckoutSession(tilled_account, CheckoutSessionCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>;
    expireCheckoutSession(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>;
    getCheckoutSession(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>;
    listCheckoutSessions(tilled_account, metadata?, payment_intent_id?, customer_id?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListCheckoutSessions200Response>)>;
}

• createCheckoutSession:function

  • createCheckoutSession(tilled_account, CheckoutSessionCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>

  • Creates a Checkout Session.

    Summary

    Create a Checkout Session

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • CheckoutSessionCreateParams: CheckoutSessionCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>

• expireCheckoutSession:function

  • expireCheckoutSession(tilled_account, id, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>

• getCheckoutSession:function

  • getCheckoutSession(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>

  • Retrieves the details of an existing Checkout Session.

    Summary

    Get a Checkout Session

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CheckoutSession>)>

• listCheckoutSessions:function

  • listCheckoutSessions(tilled_account, metadata?, payment_intent_id?, customer_id?, offset?, limit?, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional metadata: {
          [key: string]: string;
      }

      `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

      • [key: string]: string

    • Optional payment_intent_id: string

      Only return the checkout session for the payment intent specified.

    • Optional customer_id: string

      Only return the checkout session for the customer specified.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListCheckoutSessions200Response>)>