Checkout Forms

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

Browse a list of checkout forms

Browse a list of checkout forms.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of checkout forms was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/checkout-forms
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/checkout-forms?limit=1000&offset=0&sort=string&filter=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a checkout form

Create a checkout form.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
websiteId
required
string <= 50 characters

Checkout form website ID.

required
Array of Fixed quantity (object) or Variable quantity (object) 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

The plan identifier string.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

Array of Fixed quantity (object) or Variable quantity (object)
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

The plan identifier string.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

Array of Fixed quantity (object) or Variable quantity (object)
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

The plan identifier string.

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" … 154 more
object

Visual customization options for the form.

logoId
string <= 50 characters

Linked file object ID.

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.

name
required
string

Checkout form name, used for internal display to help you organize your various checkout forms. Will not be displayed to your customers.

status
string
Default: "active"

If inactive, the checkout form url will result in a 404.

Enum: "active" "inactive"
Responses
201

Checkout form was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/checkout-forms
Request samples
application/json
{
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "plans": [
    ],
  • "addonPlans": [ ],
  • "bumpPlans": [ ],
  • "accountsEnabled": false,
  • "couponsEnabled": false,
  • "purchaseLimit": null,
  • "paymentMethods": [
    ],
  • "customization": {
    },
  • "name": "string",
  • "status": "active"
}
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",
  • "name": "string",
  • "status": "active"
}

Retrieve a checkout form

Retrieve a checkout form with specified identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Checkout form was retrieved successfully.

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/organizations/unknown/checkout-forms/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -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",
  • "name": "string",
  • "status": "active"
}

Create or update a checkout form

Create or update a checkout form with predefined identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
websiteId
required
string <= 50 characters

Checkout form website ID.

required
Array of Fixed quantity (object) or Variable quantity (object) 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

The plan identifier string.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

Array of Fixed quantity (object) or Variable quantity (object)
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

The plan identifier string.

type
required
string

If variable customers will be able to choose the quantity.

Value: "fixed"
quantity
required
integer >= 1

The quantity.

Array of Fixed quantity (object) or Variable quantity (object)
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

The plan identifier string.

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" … 154 more
object

Visual customization options for the form.

logoId
string <= 50 characters

Linked file object ID.

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.

name
required
string

Checkout form name, used for internal display to help you organize your various checkout forms. Will not be displayed to your customers.

status
string
Default: "active"

If inactive, the checkout form url will result in a 404.

Enum: "active" "inactive"
Responses
200

Checkout form was updated.

201

Checkout form was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

put/checkout-forms/{id}
Request samples
application/json
{
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "plans": [
    ],
  • "addonPlans": [ ],
  • "bumpPlans": [ ],
  • "accountsEnabled": false,
  • "couponsEnabled": false,
  • "purchaseLimit": null,
  • "paymentMethods": [
    ],
  • "customization": {
    },
  • "name": "string",
  • "status": "active"
}
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",
  • "name": "string",
  • "status": "active"
}

Delete a checkout form

Delete a checkout form with predefined identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Checkout form was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/checkout-forms/{id}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/checkout-forms/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}