Get Checkout

Fetch a checkout by id. 404 if absent, deleted, or owned by another workspace.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Checkout id.

Pattern: "^[a-f0-9]{24}$"

GET/v1/checkouts/{id}

curl -X GET "https://api.3common.com/v1/checkouts/string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "checkout": {
    "id": "string",
    "ownerId": "string",
    "name": "string",
    "description": "string",
    "status": "open",
    "visibility": "private",
    "products": [
      {
        "productId": "string",
        "quantity": -9007199254740991,
        "visibility": "visible",
        "dependents": []
      }
    ],
    "maxTicketsPerSet": 0,
    "maxTicketsPerOrder": 0,
    "eventId": "string",
    "timeslotId": "string",
    "orderFormId": "string",
    "redirectUrl": "string",
    "payByInvoice": {
      "enabled": true,
      "memo": "string",
      "taxIds": [
        {
          "type": "string",
          "value": "string"
        }
      ],
      "dueInDays": -9007199254740991
    },
    "paymentMethods": [
      "card"
    ],
    "payButtonLabel": "string",
    "disableConfirmationEmail": true,
    "availableFrom": "2019-08-24T14:15:22Z",
    "availableTo": "2019-08-24T14:15:22Z",
    "availabilityTimezone": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

TypeScript

export interface Response {
  checkout: {
    id: string;
    ownerId: string;
    name: string;
    description?: string;
    status: "open" | "closed";
    visibility: "private" | "public";
    products: {
      productId: string;
      quantity?: number;
      visibility: "visible" | "conditional" | "hidden";
      dependents: {
        productId: string;
        minPerOrder?: number;
        maxPerOrder?: number;
        priceMode?: "free" | "paid" | "pwyc";
        price?: number;
        pwycMin?: number;
        customFees?: {
          id?: string;
          name: string;
          rate: number;
          isCustomFee?: boolean;
          isFixedValue?: boolean;
          includeInServiceFee?: boolean;
          defaultServiceFee?: boolean;
          isOrgDefault?: boolean;
        }[];
        includeOrgTaxes?: boolean;
      }[];
    }[];
    maxTicketsPerSet?: number;
    maxTicketsPerOrder?: number;
    eventId?: string;
    timeslotId?: string;
    orderFormId?: string;
    redirectUrl?: string;
    payByInvoice?: {
      enabled: boolean;
      memo?: string;
      taxIds?: {
        type: string;
        value: string;
      }[];
      dueInDays?: number;
    };
    paymentMethods?: ("card" | "pay_by_invoice" | "pay_later")[];
    payButtonLabel?: string;
    disableConfirmationEmail?: boolean;
    availableFrom?: string;
    availableTo?: string;
    availabilityTimezone?: string;
    createdAt: string;
    updatedAt: string;
  };
}