List checkouts

GET

https://api.schematichq.com/checkouts

GET

/checkouts

const url = 'https://api.schematichq.com/checkouts';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "company_id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "id": "string",
      "last_activity_at": "2024-01-15T09:30:00Z",
      "problems": [
        {
          "blocking": true,
          "code": "add_on_conflicts_with_plan",
          "message": "string",
          "source": "provider",
          "bundle_id": "string",
          "currency": "aed",
          "detail": "string",
          "feature_id": "string",
          "field_id": "string",
          "payment_method_id": "string",
          "plan_id": "string",
          "price_id": "string"
        }
      ],
      "selections": {
        "add_on_ids": [
          {
            "add_on_id": "string",
            "price_id": "string"
          }
        ],
        "auto_topup_overrides": [
          {
            "plan_credit_grant_id": "string",
            "auto_topup_amount": 1,
            "auto_topup_enabled": true,
            "auto_topup_threshold_credits": 1
          }
        ],
        "credit_bundles": [
          {
            "bundle_id": "string",
            "quantity": 1
          }
        ],
        "custom_field_values": [
          {
            "id": "string",
            "value": "string"
          }
        ],
        "intent": "cancel",
        "pay_in_advance": [
          {
            "price_id": "string",
            "quantity": 1
          }
        ],
        "skip_trial": true,
        "billing_entity_id": "string",
        "coupon_external_id": "string",
        "currency": "string",
        "new_plan_id": "string",
        "new_price_id": "string",
        "opt_in_accepted": true,
        "payment_method_id": "string",
        "promo_code": "string"
      },
      "status": "abandoned",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": 1,
      "completed_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z",
      "price_snapshot": {
        "amount_off": 1,
        "currency": "aed",
        "customer_balance_applied": 1,
        "customer_balance_remaining": 1,
        "discount_amount": 1,
        "discounts": [
          {
            "coupon_external_id": "string",
            "coupon_name": "string",
            "duration": "string",
            "amount_off": 1,
            "currency": "aed",
            "customer_facing_code": "string",
            "duration_in_months": 1,
            "percent_off": 1.1,
            "promo_code_external_id": "string"
          }
        ],
        "due_now": 1,
        "is_scheduled_downgrade": true,
        "new_charges": 1,
        "opt_in_required": true,
        "payment_method_required": true,
        "percent_off": 1.1,
        "period_start": "2024-01-15T09:30:00Z",
        "priced_at": "2024-01-15T09:30:00Z",
        "promo_code_applied": true,
        "proration": 1,
        "total_per_billing_period": 1,
        "opt_in_text": "string",
        "opt_in_title": "string",
        "proration_detail": {
          "charge": 1,
          "credit": 1,
          "lines": [
            {
              "amount": 1,
              "kind": "charge",
              "period_end": "2024-01-15T09:30:00Z",
              "period_start": "2024-01-15T09:30:00Z",
              "plan_id": "string",
              "price_id": "string",
              "quantity": 1
            }
          ],
          "timing": "at_renewal",
          "total": 1,
          "billed_at": "2024-01-15T09:30:00Z"
        },
        "scheduled_change_time": "2024-01-15T09:30:00Z",
        "tax_amount": 1,
        "trial_end": "2024-01-15T09:30:00Z"
      },
      "priced_at": "2024-01-15T09:30:00Z",
      "share_token": "string"
    }
  ],
  "params": {
    "company_id": "string",
    "limit": 100,
    "offset": 0,
    "statuses": [
      "abandoned"
    ]
  }
}

The checkouts this session opened for the token’s company. Filter by statuses.

Authentication

X-Schematic-Api-Keystring

A temporary access token in the X-Schematic-Api-Key header. Your server mints it with POST /temporary-access-tokens on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

Query parameters

statuseslist of enumsOptional

Only checkouts in these statuses, up to five.

Allowed values:

limitlongOptional0-250

Page limit (default 100)

offsetlongOptional0-250

Page offset (default 0)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error