PATCH
/
api
/
v1
/
product_prices
/
{id}
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "currency": "<string>",
  "product": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "uuid": "<string>",
    "id": 123,
    "name": "<string>",
    "nameEn": "<string>",
    "localCenter": "https://example.com/",
    "hasSubscription": true,
    "hasOneTimePayment": true,
    "cycleDay": 123,
    "cycleMonth": 123,
    "cycleHasProratio": true,
    "proratioMinMonthsEnabler": 123,
    "description": "<string>",
    "descriptionEn": "<string>",
    "logo": "<string>",
    "isFee": true,
    "isDonation": true,
    "settings": {
      "tenantLogo": true,
      "showTitle": true,
      "colorSelection": null,
      "colorButton": null,
      "disableSubscribe": false,
      "commentSection": true,
      "newestAndTopDonationSection": true,
      "requireFullAddress": false,
      "disableRegister": false,
      "lightThemeOnly": false,
      "isThankYouSingular": false
    },
    "descriptionInternal": "<string>",
    "cycleRecurrences": 123,
    "event": "https://example.com/",
    "startingDate": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "displayOnProfile": true,
    "productPriceVariations": [
      "https://example.com/"
    ],
    "metaGraphImage": "<string>",
    "heroVideoUrl": "<string>",
    "thankYouMessage": "<string>",
    "descriptionDe": "<string>"
  },
  "price": 123,
  "name": "<string>",
  "isArchived": true,
  "isSubscription": true,
  "isRestricted": "<string>",
  "isDefault": true,
  "fullDescription": "<string>",
  "displayNameOnPaymentPage": true,
  "overwriteMonthPeriod": 123,
  "isLifetime": true,
  "isHidden": true,
  "productPriceVariationValues": [
    "https://example.com/"
  ],
  "isBundle": true,
  "isBundleMember": true,
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "previousVersion": {},
  "monthPeriod": 123
}

Path Parameters

id
string
required

ProductPrice identifier

Body

application/merge-patch+json

The updated ProductPrice resource

currency
string | null
product
string<iri-reference>
Example:

"https://example.com/"

price
number | null
name
string | null
isArchived
boolean | null
isSubscription
boolean | null
isRestricted
string | null
isDefault
boolean | null
fullDescription
string | null
displayNameOnPaymentPage
boolean | null
overwriteMonthPeriod
integer | null
isLifetime
boolean | null
isHidden
boolean | null
productPriceVariationValues
string<iri-reference>[]
isBundle
boolean | null
validFrom
string<date-time> | null
previousVersion
object | null

Response

ProductPrice resource updated

@context
@id
string
@type
string
id
integer
currency
string | null
product
object
price
number | null
name
string | null
isArchived
boolean | null
isSubscription
boolean | null
isRestricted
string | null
isDefault
boolean | null
fullDescription
string | null
displayNameOnPaymentPage
boolean | null
overwriteMonthPeriod
integer | null
isLifetime
boolean | null
isHidden
boolean | null
productPriceVariationValues
string<iri-reference>[]
isBundle
boolean | null
isBundleMember
boolean | null
validFrom
string<date-time> | null
validTo
string<date-time> | null
previousVersion
object | null
monthPeriod
integer | null