Zum Hauptinhalt springen
PUT
/
checkout-links
/
{id}
cURL
curl -X PUT \
 /checkout-links/{id} \
 --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": "product",
      "product": {
        "type": "product",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "name": "Basic",
        "description": "For small teams.",
        "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": {
          "type": "product",
          "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
          "name": "Basic",
          "description": "For small teams.",
          "invoiceVisibility": "always",
          "customFields": {
            "field1": "value1",
            "field2": "value2"
          }
        },
        "allowCheckout": true,
        "status": "draft",
        "createdAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>"
      },
      "price": {
        "type": "flat_fee",
        "currencyCode": "EUR",
        "price": {
          "amount": 123,
          "createdAt": "2021-01-01T00:00:00+00:00",
          "updatedAt": "2021-01-01T00:00:00+00:00",
          "tenantId": "<string>"
        },
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "internalName": "Exclusive pricing for partners.",
        "status": "active",
        "salesChannel": {},
        "applyTrial": true,
        "payInAdvance": true,
        "proRata": true,
        "freeUnits": 1,
        "billingInterval": "1M",
        "showPricePerInterval": "1M",
        "custom": true,
        "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "product": "<unknown>",
        "customer": "<unknown>",
        "inUse": true,
        "checkoutLinkIds": [
          "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
        ]
      },
      "periods": [
        {
          "contractPeriod": {},
          "cancellationPeriod": {}
        }
      ]
    }
  ],
  "url": "https://example.com/checkout/my-checkout-slug"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fynn.eu/llms.txt

Use this file to discover all available pages before exploring further.

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
id
string
erforderlich

CheckoutLink identifier

Body

The updated CheckoutLink resource

​
afterCheckout
object

The action to perform after checkout.

​
options
object

The options for the checkout link.

Beispiel:
{ "trialDays": 14 }
​
isEnabled
boolean
Standard:true

Whether the checkout link is enabled or not.

Beispiel:

true

​
items
object[]
Minimum array length: 1

Antwort

CheckoutLink resource updated

​
id
string
read-only

The unique identifier of the checkout link.

Beispiel:

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

​
afterCheckout
object

The action to perform after checkout.

​
options
object
​
slug
string

The name of the checkout link.

Beispiel:

"my-checkout-slug"

​
isEnabled
boolean

Whether the checkout link is enabled or not.

Beispiel:

true

​
items
object[]
​
url
string
read-only

The URL of the checkout link.

Beispiel:

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