API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Subscription Item
Update a subscription item.
Updates the subscription item. Provided values in payload will be updated.
Required permissions:subscription:write
PATCH
/
subscription-items
/
{id}
{
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"parent": {},
"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.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>"
},
"measurementValues": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"internalName": "Exclusive pricing for partners.",
"status": "<any>",
"type": "<any>",
"applyTrial": true,
"payInAdvance": true,
"proRata": true,
"freeUnits": {},
"billingInterval": "1M",
"showPricePerInterval": "1M",
"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",
"inUse": true
},
"status": "active",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"appliedDiscounts": [
{
"id": "<string>",
"coupon": {
"id": "<string>",
"code": "10OFF",
"name": "10% off",
"type": "<any>",
"percentage": 10,
"fixedAmount": {},
"frequency": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>"
}
],
"limitedToProducts": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
}
],
"excludedFromProducts": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
}
],
"isEnabled": true,
"reedemptions": true
},
"status": "<any>",
"discount": {
"name": "10% off",
"type": "<any>",
"percentage": 10,
"fixedAmount": {},
"frequency": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"quantity": 1,
"measuredAt": "2021-01-01T00:00:00+00:00"
},
"inheritedPeriod": true
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
SubscriptionItem identifier
Body
The updated SubscriptionItem resource
Response
200
application/json
SubscriptionItem resource updated
Was this page helpful?
{
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"parent": {},
"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.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>"
},
"measurementValues": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"internalName": "Exclusive pricing for partners.",
"status": "<any>",
"type": "<any>",
"applyTrial": true,
"payInAdvance": true,
"proRata": true,
"freeUnits": {},
"billingInterval": "1M",
"showPricePerInterval": "1M",
"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",
"inUse": true
},
"status": "active",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"appliedDiscounts": [
{
"id": "<string>",
"coupon": {
"id": "<string>",
"code": "10OFF",
"name": "10% off",
"type": "<any>",
"percentage": 10,
"fixedAmount": {},
"frequency": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"allowCheckout": true,
"status": "<any>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>"
}
],
"limitedToProducts": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
}
],
"excludedFromProducts": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"internalName": "Basic (Weekly)",
"type": "product",
"measurement": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"invoiceVisibility": "always",
"costCentre": {},
"taxGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
}
}
],
"isEnabled": true,
"reedemptions": true
},
"status": "<any>",
"discount": {
"name": "10% off",
"type": "<any>",
"percentage": 10,
"fixedAmount": {},
"frequency": "<any>",
"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": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"unit": {
"id": {},
"name": "Stück"
},
"code": "users",
"description": "The number of users.",
"aggregationType": "<any>",
"fairBilling": true,
"type": "<any>"
},
"quantity": 1,
"measuredAt": "2021-01-01T00:00:00+00:00"
},
"inheritedPeriod": true
}
Assistant
Responses are generated using AI and may contain mistakes.