Skip to main content
POST
Create a checkout link

Autorisierungen

Authorization
string
header
erforderlich

Organisation API token. Send it as Authorization: Bearer api_... The token is scoped to a single Organisation.

Pfadparameter

id
string<uuid>
erforderlich

The plan UUID.

Beispiel:

"1280792f-4e23-793d-8e9c-3a1bf36630bd"

Body

application/json
planTierId
string
erforderlich

UUID of the tier the checkout link sells. Must belong to this plan.

slug
string | null

Custom URL slug. When omitted a unique slug is generated.

Required string length: 3 - 64
Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
couponsAllowed
boolean
Standard:false

Whether buyers may enter a coupon code during checkout.

isEnabled
boolean
Standard:true

Whether the link is active and reachable.

salesChannel
string | null

Sales channel as a UUID or as a technical name such as default. When omitted the active channel of the request is used, otherwise the Organisation default channel.

Antwort

The created checkout link.

id
string<uuid>
Beispiel:

"1280792f-4e23-793d-8e9c-3a1bf36630bd"

slug
string
Beispiel:

"pro-plan-pro"

planTierId
string
planTierName
string
Beispiel:

"Pro"

couponsAllowed
boolean
isEnabled
boolean
url
string<uri>

Public checkout URL that creates a cart and redirects the buyer.

Beispiel:

"https://coreapi.io/checkout-link/pro-plan-pro/cart"

createdAt
string<date-time>
updatedAt
string<date-time>
salesChannel
object | null