Restore a deleted subscription product
POSThttps://
Clears the soft-delete marker and returns the product in the detail view.
Access
- Token scope
- api:
write: subscription_products Without it:
403 insufficient-token-scope. - Permission
- subscription_products::
create Without it:
403 insufficient-permission. - Feature
- Needs the billing feature on your organisation.
Without it:
404 endpoint-not-found. - Rate cost
- 1 unit, write bucket. A write costs the same whatever
viewyou ask for. - Also
- Accepts
Idempotency-Key. AcceptsIf-Match. Never cached:private, no-store. Unknown query parameters are refused, never ignored.
Both are checked, scope first. A token never does more than its user. How access is checked
Restoring additionally requires subscription_products::delete as well as subscription_products::create. Restoring a product that is not deleted succeeds and returns an already_in_target_state warning. The restore finds a deleted product on its own, so the trashed parameter is not accepted. This is also the remedy for a 422 unique on the name: the uniqueness check counts deleted products, so restoring the product that holds the name is the fix, not retrying under another one.
Path parameters
Query parameters
Unknown parameters are refused with 400, naming the parameter.
Request headers
A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.
Response 200
Returns a SubscriptionProduct in the detail view.
Headers
ETag- A strong validator of exactly this representation.
Idempotency-Replayedtruewhen this response was replayed from a storedIdempotency-Keyrather than produced by a new write.RateLimit- The IETF
httpapi-ratelimit-headersform of your remaining allowance on the tightest bucket this request touched. RateLimit-Policy- The ceiling and window of that bucket, as
<limit>;w=<seconds>. X-Request-Id- The server-generated ULID correlating this response with our logs.
Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning
Invoice-line template for subscription lines built from this product. Supports the placeholder tokens {{$domain}}, {{$site}}, {{$server}}, {{$period}}, {{$product}} and {{$customer}}, which are filled in when the line is invoiced; the template itself is kept verbatim.
What the product costs us, as a decimal string. Null when unknown.
2 decimal places, may be negative
What the customer is billed per interval, as a decimal string. Null when the line carries its own price.
2 decimal places, may be negative
Interval the sales price is charged per.
yearlymonthlyone-time
New values may be added.
Whether this is a hosting product: one sold against a concrete site or server, which is what lets a subscription line name the infrastructure it covers.
VAT rate as a whole percentage: 21 means 21%, not 0.21. Null when the rate is decided at invoicing time.
Exact Online article this product maps to, by Exact's own external identifier (exact_items.exact_id), not by a local id.
Exact Online cost centre, by code (exact_cost_centers.code), not by id.
Errors
409 Conflict.
412 Precondition failed.
7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows POST. Anything else answers 405.
Something wrong or missing on this page? Tell us