Skip to main content
PATCH
Partial update product

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Body

application/json
name
string
required
Maximum string length: 80
unit_label
string
required
Maximum string length: 12
status
enum<string>
default:active
Available options:
active,
archived

Response

200 - application/json

Updated product.

name
string
required
Maximum string length: 80
unit_label
string
required
Maximum string length: 12
id
string
read-only
status
enum<string>
default:active
Available options:
active,
archived
archived
string<date-time> | null
read-only
plans
object[]
read-only
test_mode
boolean
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only