Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Headers

Idempotency-Key
string
required

Required for Public API write requests. Reusing the same key with the same method, path, and body replays the stored successful response; reusing it with a different request returns 409 idempotency.conflict.

Required string length: 1 - 200
Example:

"booking-create-20260714-001"

Path Parameters

productId
string
required
Example:

"66f7b8b1e13c8d25f4d3d90a"

Body

application/json
name
object

Up to 25 languages per field. Valid BCP 47 keys are canonicalized; duplicate canonical keys and und are rejected. Every non-empty map must contain defaultLanguage. Required text cannot be empty. A supplied map replaces all languages for that field; {} clears an optional field. Null maps, null values and plain strings are rejected.

description
object

Up to 25 languages per field. Valid BCP 47 keys are canonicalized; duplicate canonical keys and und are rejected. Every non-empty map must contain defaultLanguage. Required text cannot be empty. A supplied map replaces all languages for that field; {} clears an optional field. Null maps, null values and plain strings are rejected.

defaultLanguage
string

Required on create and on the first public text update of an unlocalized resource. Omit on later PATCH requests to preserve it. Changing it requires the new language in all retained non-empty text maps. Declaring a legacy source language does not translate the source text.

Maximum string length: 80
price
number

Price including VAT.

Required range: x >= 0
currency
enum<string>
Available options:
EUR,
USD,
GBP
vatPercentage
number
Required range: 0 <= x <= 100
visibility
enum<string>
Available options:
Visible,
VisibleInStore,
VisibleInStoreAndApp,
VisibleInApp,
HideProduct
trial
boolean
period
enum<string>
Available options:
Payment per month,
Payment per week,
Payment per 2 weeks,
Payment per 4 weeks,
Payment per 8 weeks,
Payment per 2 months,
Payment per 3 months,
Payment per 6 months,
Payment per year
credits
integer
Required range: x >= 0
creditCalendar
enum<string>
Available options:
,
unlimited,
per week,
per 2 weeks,
per 4 weeks,
per month,
custom
creditValidity
object
contractPeriod
integer
Required range: x >= 0
contractPeriodUnit
enum<string>
Available options:
Days,
Weeks,
Months,
Years
autoRenew
boolean
cancellationNoticePeriod
enum<string>
Available options:
No Notification,
1 Month,
2 Month,
3 Month
assignCredits
boolean
allowNegativeCredits
boolean
maxNegativeCredits
integer
Required range: x >= 0

Response

membership products updated

data
object
required
meta
object
required