Create a URL for a checkout page to accept payments.
This URL can be seamlessly integrated into your payment flow, embedded into your payment page, or used to direct customers to a hosted payment page. The link will be deactivated once the customer opens the checkout page.
The required arguments for this endpoint are checkout line items. Optionally, you can provide a return URL to redirect the customer to a specific webpage after the payment is completed.
Name | Description |
---|---|
CheckoutSubscription | Information for creating a checkout subscription |
BillingFrequencyType | How often the subscription should be attempted for billing |
SubscriptionBillingPlans | The subscription’s individual billing items |
BillingPlanName | The subscription’s primary payment information |
BillingPlanValue | Value for which the billing plan should be executed for |
Name | Description | Default value |
---|---|---|
CustomerId | Customer’s unique identifier | null |
MerchantCustomerRefId | Merchant’s identifier for the customer | null |
MerchantSubscriptionRefId | Merchant’s unique identifier for the subscription | null |
SubscriptionCancelType | The circumstances under which a subscription must be cancelled (e.g. Immediate or EndOfCycle) | |
TrialDuration | The amount of trial duration time in the unit of TrialDurationType | 0 |
TrialDurationType | The type of trial duration | Daily |
BillingPlanCycleCount | The number of times the billing plan should be billed before expiration | -1 |
BillingPlanValueType | A qualifier for how the value should be interpreted (e.g. standard, discount, discountPercentage, finalDiscount, or priceOverride) | Standard |
BillingPlanStartCycleDelay | Amount of subscription cycle to delay the start date of the billing plan | 0 |
The checkout link was successfully created
The response is of type object
.