Checkout

Create hosted checkout link

Creates a short-lived hosted checkout URL for a package, one domain, or up to 50 domain registrations. Use package_id with cycle_id for an existing package, domain with years for one domain, or domains for multiple domain registrations. callback_url is required. customer_id is optional; when supplied, it must reference a customer account (account_type 2). The checkout link is cached for 30 minutes. When the customer opens it, BillingServ creates a checkout-only session, allows supported saved payment methods, and redirects back to callback_url after payment. For package options, price, fee, and billing cycle are always resolved from the selected database option value; supplied options.amount and options.cycle_type values are accepted for request compatibility but do not override catalogue data.

post/checkout/create

Request body

Response

successtrue required

messagestring required

urlstring uri required

Hosted checkout URL to open or redirect the customer to.

Example response

{
  "message": "Successfully"
}

Changes

Changed in 2 of the 6 revisions of this API.1819

Aug 22, 20266b9208b6445611See the full diff
- ○
  added the new optional request property oneOf[CheckoutPackageRequest]/options (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property oneOf[CheckoutPackageRequest]/options (media type: application/x-www-form-urlencoded)
  new-optional-request-property
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 502 status
  response-optional-property-added
- ○
  added the optional property request_id to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property request_id to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property request_id to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property request_id to the response with the 502 status
  response-optional-property-added
Aug 15, 2026f3171dce6f0f188See the full diff
- ▲
  the request's body type/format changed from object/ to / (media type: application/json)
  request-body-type-changed
- ●
  removed the request property callback_url (media type: application/json)
  request-property-removed
- ●
  removed the request property callback_url (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property customer_id (media type: application/json)
  request-property-removed
- ●
  removed the request property customer_id (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property cycle_id (media type: application/json)
  request-property-removed
- ●
  removed the request property cycle_id (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property package_id (media type: application/json)
  request-property-removed
- ●
  removed the request property package_id (media type: application/x-www-form-urlencoded)
  request-property-removed
- ○
  added CheckoutPackageRequest CheckoutDomainRequest CheckoutDomainsRequest to the request body oneOf list (media type: application/json)
  request-body-one-of-added
- ○
  added CheckoutPackageRequest CheckoutDomainRequest CheckoutDomainsRequest to the request body oneOf list (media type: application/x-www-form-urlencoded)
  request-body-one-of-added
- ○
  the request's body type/format was generalized from object/ to / (media type: application/x-www-form-urlencoded)
  request-body-type-generalized
- ○
  added the non-success response with the status 502
  response-non-success-status-added
- ○
  the response property success became required for the status 200
  response-property-became-required
- ○
  the success response property const value true was added for the status 200
  response-property-const-added
- ○
  added the required property message to the response with the 200 status
  response-required-property-added
- ○
  added the required property url to the response with the 200 status
  response-required-property-added

Full history