Spaces
Update the pricing of a space
Sets the rental rate of the space, the deposit, whether it allows insurance and discount, and the time margins that block it around the booking.
Request examples
curl https://app.filmo.io/api/v1/spaces/spac_8f2a1c/pricing \
--request PATCH \
--header "Authorization: Bearer $FILMO_API_KEY" \
--header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
--header 'Content-Type: application/json' \
--data '{
"pricingSettings": {
"type": "periodPrice",
"price": "90.00",
"period": "hour"
},
"depositValue": "500.00",
"insuranceEnabled": false,
"discountEnabled": true,
"bufferBefore": 2,
"bufferBeforeUnit": "hour",
"bufferAfter": 2,
"bufferAfterUnit": "hour"
}'Generated from the schema
The internal cost, the external cost and the tax configuration are NOT part of the public contract. Note: the public record of a space does not emit its commercial policy, so what you write here cannot be read back through the API. Returns the updated space in detail.
Authorizations
Bearer API key with the scope below. spaces:write
Headers
Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.
Limits: min length 1, max length 255
Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"
Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Path parameters
Space identifier.
Limits: min length 1
Body
Body schema: SpacePricingBody
Rental pricing of the space, the three fields together; null clears it.
Show child attributesHide child attributes
Pricing mode.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price, as a decimal string.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Period unit of the price.
Available options: hour, day, week, month
Whether the space allows insurance.
Security deposit amount, as a decimal string; null clears it.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Whether the space allows a discount.
Time buffer reserved BEFORE the rental; null clears it together with its unit.
Limits: min 0
Unit of the preceding buffer; null only together with bufferBefore: null.
Available options: hour, day
Time buffer reserved AFTER the rental; null clears it together with its unit.
Limits: min 0
Unit of the following buffer; null only together with bufferAfter: null.
Available options: hour, day
Response
Successful response.
Response schema: SpaceDetailDto
Envelope: SpaceDetailResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay
Detail of a warehouse or rentable space.
Show child attributesHide child attributes
Unique space identifier.
Space name.
Internal reference of the space, useful for matching with external systems; null if it has none.
true if the space is a warehouse that manages stock and can be the main warehouse of an order; false if it is a rentable space.
Identifier of the collection it belongs to; null if it is in none.
Full collection path, for example "Estudios > Fotografía"; null if not applicable.
Building it is located in; null if not applicable.
Floor it is located on; null if not applicable.
Physical location of the space.
Show child attributesHide child attributes
Postal address; null if not recorded.
Municipality; null if not recorded.
Postal code; null if not recorded.
Country; null if not recorded.
Latitude in decimal degrees; null if not geolocated.
Longitude in decimal degrees; null if not geolocated.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Space description; null if it has none.
Capacity in people; null if not defined.
Area in square metres; null if not defined.
Dimensions as free text; null if not defined.
Additional services available (wifi, projector...).
Fixed equipment available in the space.
Rental pricing of the space; null if not configured. The same fields that PATCH /pricing accepts.
Show child attributesHide child attributes
Pricing mode; null if not configured.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price as a decimal string; null if not configured.
Limits: pattern ^-?\d+\.\d{2}$
Period unit of the price; null if not configured.
Available options: hour, day, week, month
Whether the space allows insurance.
Whether the space allows a discount.
Security deposit amount as a decimal string; null if not set.
Limits: pattern ^-?\d+\.\d{2}$
Time buffer reserved BEFORE the rental; null if none.
Unit of the preceding buffer; null if none.
Available options: hour, day
Time buffer reserved AFTER the rental; null if none.
Unit of the following buffer; null if none.
Available options: hour, day
Custom field values by custom field identifier; the definitions are in /api.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Invalid request (validation_error): malformed query or body. errors[] lists every offending field with its stable code.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language · Idempotent-Replay
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language · Idempotent-Replay
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (If-Match) held the resource for more than five seconds. errors[0]. says which: in_progress and lock_timeout are solved by retrying; invalid_state is not, because the state of the resource forbids the operation.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Precondition failed (precondition_failed): the If-Match entity tag does not match the current representation. Read the resource again and retry.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After · Idempotent-Replay
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Errors
| Status | Codes | Meaning |
|---|---|---|
| 400 | validation_error | Malformed query or body. errors[] lists every offending field with its stable code. |
| 404 | not_found | It does not exist or is outside the scope of the API key. |
| 409 | conflict | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (If-Match) held the resource for more than five seconds. errors[0]. says which: in_progress and lock_timeout are solved by retrying; invalid_state is not, because the state of the resource forbids the operation. |
| 412 | precondition_failed | The If-Match entity tag does not match the current representation. Read the resource again and retry. |
| 422 | idempotency_key_reused | The same key was used before with a different body. Change the key. |
401, 403, 429, 500 can be returned by any operation. Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related pages
Link to this section: Related pagesCatalog & inventory
Space
Warehouse or rentable space of the account.
Was this page helpful?