Skip to main content
POST
Create hosted checkout link

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <live_api_key>.

Body

Provide exactly one checkout type: an existing package, one domain, or a list of domains.

package_id
integer
required

Package or order-group package ID to add to checkout.

Required range: x >= 1
cycle_id
integer
required

Billing cycle ID for the selected package.

Required range: x >= 1
callback_url
string<uri>
required

URL BillingServ redirects to after hosted checkout succeeds or fails.

customer_id
integer | null

Optional existing BillingServ customer user ID. If supplied, the user must have account_type 2.

Required range: x >= 1
options
object

Optional selected package options. Each option must belong to the selected package; option prices are resolved server-side.

Response

OK

A hosted checkout URL created by BillingServ. The URL expires after 30 minutes if it is not completed.

success
boolean
required
message
string
required
Example:

"Successfully"

url
string<uri>
required

Hosted checkout URL to open or redirect the customer to.