POST
/
checkout-links
cURL
curl -X POST \
 /checkout-links \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "afterCheckout": {
        "url": "https:\/\/example.com\/checkout\/confirmation",
        "confirmationMessage": "Thank you for your order!",
        "action": "redirect",
        "backToProviderUrl": "https:\/\/example.com\/checkout\/confirmation"
    },
    "options": {
        "trialDays": "14",
        "allowCoupons": "",
        "quantityEditable": "",
        "forceCompany": ""
    },
    "isEnabled": "1",
    "items": [
        []
    ]
}'
{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "afterCheckout": {
    "url": "https://example.com/checkout/confirmation",
    "confirmationMessage": "Thank you for your order!",
    "action": "redirect",
    "backToProviderUrl": "https://example.com/checkout/confirmation"
  },
  "options": {
    "trialDays": 14,
    "allowCoupons": true,
    "quantityEditable": true,
    "forceCompany": true
  },
  "slug": "my-checkout-slug",
  "isEnabled": true,
  "items": [
    {
      "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": {}
        }
      ]
    }
  ],
  "url": "https://example.com/checkout/my-checkout-slug"
}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Body

The new CheckoutLink resource

afterCheckout
object

The action to perform after checkout.

options
object

The options for the checkout link.

isEnabled
boolean
default:true

Whether the checkout link is enabled or not.

Example:

true

items
object[]
Minimum length: 1

Response

CheckoutLink resource created

id
string

The unique identifier of the checkout link.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

afterCheckout
object

The action to perform after checkout.

options
object
slug
string

The name of the checkout link.

Example:

"my-checkout-slug"

isEnabled
boolean

Whether the checkout link is enabled or not.

Example:

true

items
object[]
url
string

The URL of the checkout link.

Example:

"https://example.com/checkout/my-checkout-slug"