Zum Hauptinhalt springen
GET
cURL

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id
string
erforderlich

CheckoutLinkItem identifier

Antwort

CheckoutLinkItem resource

type
any
read-only

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.
Beispiel:

"product"

product
object | null

This is required when the type is "product".

quantity
number · null · null

This is required when the type is "product".

Beispiel:

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[]
read-only

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.