List Checkout Sessions

Intent

Reads the available checkout sessions as a pageable collection without changing them.

When to call it

Call this when an interface, sync, or support workflow needs to inspect checkout sessions. Use the filters and paging controls shown below to limit the result.

Access boundary

Authorize the request with a token that carries checkouts:read or checkouts:write.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

GET

checkouts

List Checkout Sessions

curl --request GET \
  --url https://api.getruba.com/v1/checkouts/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getruba.com/v1/checkouts/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/checkouts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/checkouts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/checkouts/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getruba.com/v1/checkouts/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/checkouts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "payment_processor": "stripe",
      "client_secret": "<string>",
      "url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "success_url": "<string>",
      "return_url": "<string>",
      "embed_origin": "<string>",
      "amount": 123,
      "discount_amount": 123,
      "net_amount": 123,
      "tax_amount": 123,
      "total_amount": 123,
      "currency": "<string>",
      "allow_trial": true,
      "active_trial_interval_count": 123,
      "trial_end": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "discount_id": "<string>",
      "allow_discount_codes": true,
      "require_billing_address": true,
      "is_discount_applicable": true,
      "is_free_product_price": true,
      "is_payment_required": true,
      "is_payment_setup_required": true,
      "is_payment_form_required": true,
      "customer_id": "<string>",
      "is_business_customer": true,
      "customer_name": "<string>",
      "customer_email": "<string>",
      "customer_ip_address": "<string>",
      "customer_billing_name": "<string>",
      "customer_billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "customer_tax_id": "<string>",
      "payment_processor_metadata": {},
      "billing_address_fields": {},
      "trial_interval_count": 123,
      "metadata": {},
      "external_customer_id": "<string>",
      "products": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "trial_interval_count": 123,
          "name": "<string>",
          "description": "<string>",
          "recurring_interval_count": 123,
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>",
          "prices": [
            {
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z",
              "id": "<string>",
              "amount_type": "<string>",
              "price_currency": "<string>",
              "is_archived": true,
              "product_id": "<string>",
              "type": "<string>",
              "price_amount": 123,
              "legacy": true
            }
          ],
          "benefits": [
            {
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "selectable": true,
              "deletable": true,
              "is_deleted": true,
              "organization_id": "<string>"
            }
          ],
          "medias": [
            {
              "id": "<string>",
              "organization_id": "<string>",
              "name": "<string>",
              "path": "<string>",
              "mime_type": "<string>",
              "size": 123,
              "storage_version": "<string>",
              "checksum_etag": "<string>",
              "checksum_sha256_base64": "<string>",
              "checksum_sha256_hex": "<string>",
              "last_modified_at": "2023-11-07T05:31:56Z",
              "version": "<string>",
              "service": "<string>",
              "is_uploaded": true,
              "created_at": "2023-11-07T05:31:56Z",
              "size_readable": "<string>",
              "public_url": "<string>"
            }
          ]
        }
      ],
      "product": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "trial_interval_count": 123,
        "name": "<string>",
        "description": "<string>",
        "recurring_interval_count": 123,
        "is_recurring": true,
        "is_archived": true,
        "organization_id": "<string>",
        "prices": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "amount_type": "<string>",
            "price_currency": "<string>",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "price_amount": 123,
            "legacy": true
          }
        ],
        "benefits": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "selectable": true,
            "deletable": true,
            "is_deleted": true,
            "organization_id": "<string>"
          }
        ],
        "medias": [
          {
            "id": "<string>",
            "organization_id": "<string>",
            "name": "<string>",
            "path": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "storage_version": "<string>",
            "checksum_etag": "<string>",
            "checksum_sha256_base64": "<string>",
            "checksum_sha256_hex": "<string>",
            "last_modified_at": "2023-11-07T05:31:56Z",
            "version": "<string>",
            "service": "<string>",
            "is_uploaded": true,
            "created_at": "2023-11-07T05:31:56Z",
            "size_readable": "<string>",
            "public_url": "<string>"
          }
        ]
      },
      "product_price": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount_type": "<string>",
        "price_currency": "<string>",
        "is_archived": true,
        "product_id": "<string>",
        "type": "<string>",
        "price_amount": 123,
        "legacy": true
      },
      "prices": {},
      "discount": {
        "amount": 123,
        "currency": "<string>",
        "amounts": {},
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "subscription_id": "<string>",
      "attached_custom_fields": [
        {
          "custom_field_id": "<string>",
          "custom_field": {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "metadata": {},
            "type": "<string>",
            "slug": "<string>",
            "name": "<string>",
            "organization_id": "<string>",
            "properties": {
              "form_label": "<string>",
              "form_help_text": "<string>",
              "form_placeholder": "<string>",
              "textarea": true,
              "min_length": 1073741823,
              "max_length": 1073741823
            }
          },
          "order": 123,
          "required": true
        }
      ],
      "customer_metadata": {},
      "custom_field_data": {},
      "seats": 123,
      "min_seats": 123,
      "max_seats": 123,
      "locale": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Authentication: You can generate a Personal Access Token from your settings.

Query Parameters

organization_id

Return only records matching organization ID. Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

product_id

Return only records matching product ID. Identifier of the product.

customer_id

Return only records matching customer ID. Identifier of the customer.

external_customer_id

Return only records matching customer external ID. Identifier of the customer external.

status

Return only records matching checkout session status.

Available options:

open,

expired,

confirmed,

succeeded,

failed

query

string | null

Return only records matching customer email.

page

integer

default:1

Results page to return. The first page is used by default.

limit

integer

default:10

Records returned per page. Defaults to 10 and accepts up to 100.

sorting

enum<string>[] | null

Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.

Available options:

created_at,

-created_at,

expires_at,

-expires_at,

status,

-status

Response

Request completed successfully

items

Checkout · object[]

required

Show child attributes

pagination

Pagination · object

required

Show child attributes

Complete Checkout Session from Client### Intent Runs the complete checkout session from client action. ### When to call it Call this when your workflow reaches the point where it must complete checkout session from client. ### Access boundary Use the credential type and authentication scheme shown for this operation. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives. ### Operational notes Complete a checkout session by client secret. Orders and subscriptions will be processed.

⌘I

List Checkout Sessions

curl --request GET \
  --url https://api.getruba.com/v1/checkouts/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getruba.com/v1/checkouts/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/checkouts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/checkouts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/checkouts/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getruba.com/v1/checkouts/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/checkouts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "payment_processor": "stripe",
      "client_secret": "<string>",
      "url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "success_url": "<string>",
      "return_url": "<string>",
      "embed_origin": "<string>",
      "amount": 123,
      "discount_amount": 123,
      "net_amount": 123,
      "tax_amount": 123,
      "total_amount": 123,
      "currency": "<string>",
      "allow_trial": true,
      "active_trial_interval_count": 123,
      "trial_end": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "discount_id": "<string>",
      "allow_discount_codes": true,
      "require_billing_address": true,
      "is_discount_applicable": true,
      "is_free_product_price": true,
      "is_payment_required": true,
      "is_payment_setup_required": true,
      "is_payment_form_required": true,
      "customer_id": "<string>",
      "is_business_customer": true,
      "customer_name": "<string>",
      "customer_email": "<string>",
      "customer_ip_address": "<string>",
      "customer_billing_name": "<string>",
      "customer_billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "customer_tax_id": "<string>",
      "payment_processor_metadata": {},
      "billing_address_fields": {},
      "trial_interval_count": 123,
      "metadata": {},
      "external_customer_id": "<string>",
      "products": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "trial_interval_count": 123,
          "name": "<string>",
          "description": "<string>",
          "recurring_interval_count": 123,
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>",
          "prices": [
            {
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z",
              "id": "<string>",
              "amount_type": "<string>",
              "price_currency": "<string>",
              "is_archived": true,
              "product_id": "<string>",
              "type": "<string>",
              "price_amount": 123,
              "legacy": true
            }
          ],
          "benefits": [
            {
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "modified_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "selectable": true,
              "deletable": true,
              "is_deleted": true,
              "organization_id": "<string>"
            }
          ],
          "medias": [
            {
              "id": "<string>",
              "organization_id": "<string>",
              "name": "<string>",
              "path": "<string>",
              "mime_type": "<string>",
              "size": 123,
              "storage_version": "<string>",
              "checksum_etag": "<string>",
              "checksum_sha256_base64": "<string>",
              "checksum_sha256_hex": "<string>",
              "last_modified_at": "2023-11-07T05:31:56Z",
              "version": "<string>",
              "service": "<string>",
              "is_uploaded": true,
              "created_at": "2023-11-07T05:31:56Z",
              "size_readable": "<string>",
              "public_url": "<string>"
            }
          ]
        }
      ],
      "product": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "trial_interval_count": 123,
        "name": "<string>",
        "description": "<string>",
        "recurring_interval_count": 123,
        "is_recurring": true,
        "is_archived": true,
        "organization_id": "<string>",
        "prices": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "amount_type": "<string>",
            "price_currency": "<string>",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "price_amount": 123,
            "legacy": true
          }
        ],
        "benefits": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "selectable": true,
            "deletable": true,
            "is_deleted": true,
            "organization_id": "<string>"
          }
        ],
        "medias": [
          {
            "id": "<string>",
            "organization_id": "<string>",
            "name": "<string>",
            "path": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "storage_version": "<string>",
            "checksum_etag": "<string>",
            "checksum_sha256_base64": "<string>",
            "checksum_sha256_hex": "<string>",
            "last_modified_at": "2023-11-07T05:31:56Z",
            "version": "<string>",
            "service": "<string>",
            "is_uploaded": true,
            "created_at": "2023-11-07T05:31:56Z",
            "size_readable": "<string>",
            "public_url": "<string>"
          }
        ]
      },
      "product_price": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount_type": "<string>",
        "price_currency": "<string>",
        "is_archived": true,
        "product_id": "<string>",
        "type": "<string>",
        "price_amount": 123,
        "legacy": true
      },
      "prices": {},
      "discount": {
        "amount": 123,
        "currency": "<string>",
        "amounts": {},
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "subscription_id": "<string>",
      "attached_custom_fields": [
        {
          "custom_field_id": "<string>",
          "custom_field": {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "metadata": {},
            "type": "<string>",
            "slug": "<string>",
            "name": "<string>",
            "organization_id": "<string>",
            "properties": {
              "form_label": "<string>",
              "form_help_text": "<string>",
              "form_placeholder": "<string>",
              "textarea": true,
              "min_length": 1073741823,
              "max_length": 1073741823
            }
          },
          "order": 123,
          "required": true
        }
      ],
      "customer_metadata": {},
      "custom_field_data": {},
      "seats": 123,
      "min_seats": 123,
      "max_seats": 123,
      "locale": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

List Checkout Sessions

Intent

When to call it

Access boundary

Successful result

Authorizations

Query Parameters

Response