Checkout Forms

Hosted checkout forms can be configured here. You can customize various options that appear on your hosted checkout forms.

Retrieve a checkout form

Retrieve a checkout form with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Checkout form was retrieved successfully.

Response Schema: application/json
websiteId
required
string <= 50 characters

The resource ID. Defaults to UUID v4.

required
Array of objects or objects non-empty

The list of plans that would be applied to customer order by default.

Array (non-empty)
One of:
planId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

Array of objects or objects
Default: []

The list of independent addons. Customer will be able to select whether to add the plans from the list or not.

Array
One of:
planId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

Array of objects or objects
Default: []

The list of plans that can be used instead of ones specified in plans. Customer will be able to select whether to purchase bump plans or the regular ones.

Array
One of:
planId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

accountsEnabled
boolean
Default: false

If true customer will be able to sign-up and sign-in using the form.

couponsEnabled
boolean
Default: false

If true customer will be able to use coupons on the form.

purchaseLimit
integer or null >= 0
Default: null

If the purchase limit is set, every purchase will decrease it. Zero purchase limit will make form inactive.

paymentMethods
Array of strings (PaymentMethod)

The list of available payment methods. Only payment methods with at least one active gateway account are allowed. If not specified all available payment methods will be displayed.

Items Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
object

Visual customization options for the form.

logoId
string <= 50 characters

The resource ID. Defaults to UUID v4.

summary
string

Summary text.

buttonText
string
Default: "Pay {{amount}}"

You can use placeholder {{amount}} to substitute with the form total.

object

Control the primary color used in the form and button text.

primary
string <= 6 characters
Default: "0044d4"

Primary color for the form in hexadecimal format.

buttonText
string <= 6 characters
Default: "ffffff"

Button text color for the form in hexadecimal format.

object

Various urls that appear on the form.

refundPolicy
string <url>

The url to the website refund policy.

privacyPolicy
string <url>

The url to the website privacy policy.

termsOfService
string <url>

The url to the website terms of service.

object

Various tracking system identifier strings.

googleAnalytics
string

The Google Analytics tracking identifier string.

googleTagManager
string

The Google Tag Manager tracking identifier string.

gtagJs
string

The Google Analytics tracking identifier string for Google's Global Site Tag (gtag.js) service.

facebookPixel
string

The Facebook Pixel tracking identifier string.

segmentAnalytics
string

The Segment Analytics tracking identifier string.

heapIo
string

The Heap.io tracking identifier string.

requiredAdditionalFields
Array of strings

The list of fields which are marked as required.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

token
string

The session's token used for authentication.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/checkout-forms/{id}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/storefront/checkout-forms/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "plans": [
    ],
  • "addonPlans": [ ],
  • "bumpPlans": [ ],
  • "accountsEnabled": false,
  • "couponsEnabled": false,
  • "purchaseLimit": null,
  • "paymentMethods": [
    ],
  • "customization": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "_links": [
    ]
}