Checkout forms

Use these operations to create and manage checkout forms. Rebilly hosted checkout forms provide secure and compliant checkouts. Checkout forms are customizable, and use fully responsive design, built-in error messaging, validation, and expedited checkout for returning customers.

Operations

Retrieve checkout forms
deprecated

Request

Retrieves a list of checkout forms.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/checkout-forms?limit=1000&offset=1000&sort=string&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Checkout forms retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the checkout form.

Example:"chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP"
websiteIdstring, <= 50 characters(WebsiteId)required

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
customDomainstring or null, <= 255 characters

Custom domain for the checkout form.

plansArray of objects, non-empty(CheckoutFormPlan)required

List of plans that are applied to a customer order by default. Plans describe how the customer must pay for products. For more information, see Plans.

addonPlansArray of objects(CheckoutFormPlan)

List of add-on plans that are displayed to the customer on the payment screen. Add-ons are plans that the customer has not already subscribed to.

The customer selects whether to add an add-on plan to their current order.

Default:[]
bumpPlansArray of objects(CheckoutFormPlan)

List of bump plans that are displayed to the customer on the payment screen. Use bump plans to offer purchase bonuses, discounts, and deals to the customer.

The customer selects whether to purchase bump plans, or to use the plans that are specified in their current order.

Default:[]
accountsEnabledboolean

Specifies if the account is enabled. If this value is true, the customer can sign-up and sign-in using the checkout form.

Default:false
couponsEnabledboolean

Specifies if coupons are enabled in the checkout form. If this value is true, the customer can use coupons in the checkout form. Use coupons to reward customers, generate sales, or to test new pricing strategies.

Default:false
purchaseLimitinteger or null, >= 0

Limits the number of purchases that can be made using a specific checkout form. If a purchase limit value is set, each purchase decreases this value. When the purchases limit value reaches zero, the checkout form becomes inactive.

Default:null
paymentMethodsArray of strings

List of available payment methods. Payment methods must have at least one active gateway account. If not specified, all available payment methods are displayed.

customizationobject

Visual customization options for the checkout form.

namestringrequired

Name of the checkout form. This name value is for internal display, and is not visible to your customers. Use this name to locate and organize your checkout forms.

statusstring

Status of the checkout form. If the status value is inactive, the checkout form URL produces a 404 error.

Default:"active"
Enum:"active""inactive"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP",
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "customDomain": "string",
    "plans": [ … ],
    "addonPlans": [],
    "bumpPlans": [],
    "accountsEnabled": false,
    "couponsEnabled": false,
    "purchaseLimit": null,
    "paymentMethods": [ … ],
    "customization": { … },
    "name": "string",
    "status": "active",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]