Skip to main content
PATCH
/
subscription-items
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
  "parent": "<unknown>",
  "plan": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "family": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
    },
    "code": "basic-m2023",
    "originProduct": {
      "type": "product",
      "measurement": {
        "unit": {
          "id": {},
          "name": "Stück"
        },
        "code": "users",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "description": "The number of users.",
        "aggregationType": "sum",
        "fairBilling": true,
        "type": "recurring"
      },
      "taxGroup": {},
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "name": "Basic",
      "description": "For small teams.",
      "internalName": "Basic (Weekly)",
      "invoiceVisibility": "always",
      "costCentre": {},
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      }
    },
    "allowCheckout": true,
    "status": "draft",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>"
  },
  "measurementValues": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "measurement": {
        "unit": {
          "id": {},
          "name": "Stück"
        },
        "code": "users",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "description": "The number of users.",
        "aggregationType": "sum",
        "fairBilling": true,
        "type": "recurring"
      },
      "quantity": 1,
      "measuredAt": "2021-01-01T00:00:00+00:00"
    }
  ],
  "billing": {
    "lastBilledAt": "2023-11-07T05:31:56Z",
    "lastBilledTo": "2023-11-07T05:31:56Z",
    "lastBilledFrom": "2023-11-07T05:31:56Z",
    "nextBillingAt": "2023-11-07T05:31:56Z",
    "billingInterval": "1M"
  },
  "name": "Fitness M",
  "description": "Everything included",
  "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
  "pricePlan": {
    "type": "flat_fee",
    "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",
    "applyTrial": true,
    "payInAdvance": true,
    "proRata": true,
    "freeUnits": {},
    "billingInterval": "1M",
    "showPricePerInterval": "1M",
    "custom": true,
    "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "inUse": true
  },
  "status": "active",
  "product": {
    "type": "product",
    "measurement": {
      "unit": {
        "id": {},
        "name": "Stück"
      },
      "code": "users",
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "description": "The number of users.",
      "aggregationType": "sum",
      "fairBilling": true,
      "type": "recurring"
    },
    "taxGroup": {},
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "name": "Basic",
    "description": "For small teams.",
    "internalName": "Basic (Weekly)",
    "invoiceVisibility": "always",
    "costCentre": {},
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
  },
  "appliedDiscounts": [
    {
      "id": "<string>",
      "coupon": {
        "code": "10OFF",
        "name": "10% off",
        "type": "percentage",
        "frequency": "limited",
        "id": "<string>",
        "percentage": 10,
        "fixedAmount": {},
        "frequencyInterval": 3,
        "maxRedemptionsPerCustomer": "null",
        "maxRedemptions": "null",
        "expiresAt": "null",
        "limitedToPlans": [
          {
            "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
            "family": {
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
            },
            "code": "basic-m2023",
            "originProduct": {
              "type": "product",
              "measurement": {
                "unit": {
                  "id": {},
                  "name": "Stück"
                },
                "code": "users",
                "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
                "description": "The number of users.",
                "aggregationType": "sum",
                "fairBilling": true,
                "type": "recurring"
              },
              "taxGroup": {},
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
              "name": "Basic",
              "description": "For small teams.",
              "internalName": "Basic (Weekly)",
              "invoiceVisibility": "always",
              "costCentre": {},
              "customFields": {
                "field1": "value1",
                "field2": "value2"
              }
            },
            "allowCheckout": true,
            "status": "draft",
            "createdAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "description": "<string>"
          }
        ],
        "excludedFromPlans": [
          {
            "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
            "family": {
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
            },
            "code": "basic-m2023",
            "originProduct": {
              "type": "product",
              "measurement": {
                "unit": {
                  "id": {},
                  "name": "Stück"
                },
                "code": "users",
                "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
                "description": "The number of users.",
                "aggregationType": "sum",
                "fairBilling": true,
                "type": "recurring"
              },
              "taxGroup": {},
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
              "name": "Basic",
              "description": "For small teams.",
              "internalName": "Basic (Weekly)",
              "invoiceVisibility": "always",
              "costCentre": {},
              "customFields": {
                "field1": "value1",
                "field2": "value2"
              }
            },
            "allowCheckout": true,
            "status": "draft",
            "createdAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "description": "<string>"
          }
        ],
        "limitedToProducts": [
          {
            "type": "product",
            "measurement": {
              "unit": {
                "id": {},
                "name": "Stück"
              },
              "code": "users",
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
              "description": "The number of users.",
              "aggregationType": "sum",
              "fairBilling": true,
              "type": "recurring"
            },
            "taxGroup": {},
            "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
            "name": "Basic",
            "description": "For small teams.",
            "internalName": "Basic (Weekly)",
            "invoiceVisibility": "always",
            "costCentre": {},
            "customFields": {
              "field1": "value1",
              "field2": "value2"
            }
          }
        ],
        "excludedFromProducts": [
          {
            "type": "product",
            "measurement": {
              "unit": {
                "id": {},
                "name": "Stück"
              },
              "code": "users",
              "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
              "description": "The number of users.",
              "aggregationType": "sum",
              "fairBilling": true,
              "type": "recurring"
            },
            "taxGroup": {},
            "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
            "name": "Basic",
            "description": "For small teams.",
            "internalName": "Basic (Weekly)",
            "invoiceVisibility": "always",
            "costCentre": {},
            "customFields": {
              "field1": "value1",
              "field2": "value2"
            }
          }
        ],
        "isEnabled": true,
        "reedemptions": true
      },
      "status": "active",
      "discount": {
        "name": "10% off",
        "type": "percentage",
        "frequency": "limited",
        "percentage": 10,
        "fixedAmount": {},
        "frequencyInterval": 3
      },
      "appliedIntervals": 1
    }
  ],
  "periods": [
    {
      "id": "<string>",
      "contractPeriodCount": 123,
      "contractPeriod": {},
      "cancellationPeriod": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "activatedAt": "2021-01-01T00:00:00+00:00",
  "type": "addon",
  "currentMeasurementValue": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "measurement": {
      "unit": {
        "id": {},
        "name": "Stück"
      },
      "code": "users",
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "description": "The number of users.",
      "aggregationType": "sum",
      "fairBilling": true,
      "type": "recurring"
    },
    "quantity": 1,
    "measuredAt": "2021-01-01T00:00:00+00:00"
  },
  "inheritedPeriod": true
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

SubscriptionItem identifier

Body

The updated SubscriptionItem resource

​
name
string
required

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

Maximum string length: 255
Example:

"Fitness M"

​
description
string | null

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

Maximum string length: 5000
Example:

"Everything included"

​
furtherInformation
string | null

Further information defines additional information for the item which will be displayed in the invoice.

Maximum string length: 5000
Example:

"Additional agreements: The contract includes a free drink flatrate."

​
periods
object[]

The contract period terms of the subscription item. If empty, it is always cancelable.

Response

SubscriptionItem resource updated

​
id
string
Example:

"01F9ZQZJZJQZJZJZJZJZJZJZJZ"

​
parent
any | null

The parent item of the item. If this is null, the item is a root item.

​
plan
object

The plan this item is based on.

​
measurementValues
object[]

Usage values during the subscription item period.

​
billing
object

The billing details of the item.

​
name
string

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

Example:

"Fitness M"

​
description
string | null

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

Example:

"Everything included"

​
furtherInformation
string | null

Further information defines additional information for the item which will be displayed in the invoice.

Example:

"Additional agreements: The contract includes a free drink flatrate."

​
pricePlan
object

The price plan of the item, which defines the price and billing interval.

​
status
enum<string>

The status of the item.

Possible values:

  • active: The item is active and will be billed.
  • canceled: The item is canceled and will be billed until the end of the contract.
  • pending: The item is pending and will be billed after the contract start.
  • terminated: The item is terminated and will not be billed.
Available options:
active,
canceled,
pending,
terminated
Example:

"active"

​
product
object

The product of the item.

​
appliedDiscounts
object[]
​
periods
object[]
​
activatedAt
string<date-time> | null

The date the subscription item was activated.

Example:

"2021-01-01T00:00:00+00:00"

​
type
enum<string>

The type of the item.

Possible values:

  • option: The item is an product set option.
  • charge: The item is a charge.
  • plan-product: The item is a plan product.
  • product: The item is a product, and not created from a plan.
Available options:
addon,
charge,
plan-product,
product
Example:

"addon"

​
currentMeasurementValue
object

The current measurement value of the item.

​
inheritedPeriod
boolean

Is the period inherited from the subscription?

Example:

true