BillingCheckoutResource
The BillingCheckoutResource
type represents information about a checkout session.
Properties
- Name
-
confirm
- Type
(params: ConfirmCheckoutParams) => Promise<BillingCheckoutResource>
- Description
A function to confirm and finalize the checkout process, usually after payment information has been provided and validated. Learn more.
- Name
-
payer
- Type
BillingPayerResource
- Description
The payer associated with the checkout.
- Name
-
paymentSource?
- Type
BillingPaymentSourceResource
- Description
The payment source being used for the checkout, such as a credit card or bank account.
- Name
-
plan
- Type
BillingPlanResource
- Description
The subscription plan details for the checkout.
- Name
-
totals
- Type
BillingCheckoutTotals
- Description
The total costs, taxes, and other pricing details for the checkout.
confirm()
The confirm()
function is used to confirm and finalize the checkout process, usually after payment information has been provided and validated.
Parameters
The confirm()
method accepts the following parameters. Only one of paymentSourceId
, paymentToken
, or useTestCard
should be provided.
There are multiple variants of this type available which you can select by clicking on one of the tabs.
- Name
paymentSourceId?
- Type
string
- Description
The ID of a saved payment source to use for this checkout.
- Name
gateway?
- Type
"stripe" | "paypal"
- Description
The payment gateway to use. Required if
paymentToken
oruseTestCard
is provided.
- Name
paymentToken?
- Type
string
- Description
A token representing payment details, usually from a payment form. Requires
gateway
to be provided.
- Name
gateway?
- Type
"stripe" | "paypal"
- Description
The payment gateway to use. Required if
paymentToken
oruseTestCard
is provided.
- Name
useTestCard?
- Type
boolean
- Description
If true, uses a test card for the checkout. Requires
gateway
to be provided.
Feedback
Last updated on