Update a checkout | SchematicHQ

const url = 'https://api.schematichq.com/checkouts/checkout_id';
const options = {
  method: 'PUT',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"version":1}'
};
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": {}
}

Replaces the cart and prices it again. Send the version last read; a stale one answers 409 and changes nothing, so read the checkout and send the write again at its version. A cart the purchase rules reject is saved with its price cleared and one problem saying why, and the version still advances. The X-Checkout-Session-ID response header names the session this price belongs to; send it back on the finalize that follows.

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.

Path parameters

checkout_idstringRequired

checkout_id

Request

This endpoint expects an object.

versionlongRequired

add_on_idslist of objectsOptional

auto_topup_overrideslist of objectsOptional

billing_entity_idstring or nullOptional

coupon_external_idstring or nullOptional<=255 characters

credit_bundleslist of objectsOptional

currencyenum or nullOptional

ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem.

custom_field_valueslist of objectsOptional

intentenum or nullOptional

What the checkout does to the subscription: change it to the cart’s contents, or cancel it. Omit it to keep the checkout’s current intent.

Allowed values:

new_plan_idstringOptional

new_price_idstringOptional

opt_in_acceptedboolean or nullOptional

pay_in_advancelist of objectsOptional

payment_method_idstring or nullOptional<=255 characters

promo_codestring or nullOptional<=255 characters

skip_trialbooleanOptional

Response headers

X-Checkout-Session-IDstringOptional

The checkout session this price belongs to. Send it back on the purchase that follows.

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error