GET
/
checkout-link-items
/
{id}
cURL
curl -X GET \
 /checkout-link-items/{id} \
 --header "Authorization: Bearer <token>"
{
  "type": "<any>",
  "product": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "name": "Basic",
    "description": "For small teams.",
    "type": "product",
    "invoiceVisibility": "always",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
  },
  "quantity": 1,
  "plan": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "family": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
    },
    "code": "basic-m2023",
    "originProduct": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "name": "Basic",
      "description": "For small teams.",
      "type": "product",
      "invoiceVisibility": "always",
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      }
    },
    "allowCheckout": true,
    "status": "<any>",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>"
  },
  "price": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "internalName": "Exclusive pricing for partners.",
    "status": "<any>",
    "salesChannel": {},
    "type": "<any>",
    "applyTrial": true,
    "payInAdvance": true,
    "proRata": true,
    "freeUnits": {},
    "billingInterval": "1M",
    "showPricePerInterval": "1M",
    "currencyCode": {},
    "price": {
      "amount": 123,
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00",
      "tenantId": "<string>"
    },
    "custom": true,
    "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "product": "<any>",
    "customer": "<any>",
    "inUse": true,
    "checkoutLinkIds": [
      "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
    ]
  },
  "periods": [
    {
      "contractPeriod": {},
      "cancellationPeriod": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

CheckoutLinkItem identifier

Response

CheckoutLinkItem resource

type
any

The type of the checkout link item.

Possible values:

  • product: A product will be added to the cart, with the given quantity.
  • plan: A plan will be added to the cart, and can be configured by the customer.
product
object | null

This is required when the type is "product".

quantity
object | null

This is required when the type is "product".

Example:

1

plan
object | null

This is required when the type is "plan".

price
object | null

This is required when the type is "product", "plan".

periods
object[]

The contract period terms of the product item. If none provided, the billing period will be used as contract period, the cancellation period is set to 1 day.