Skip to main content
PATCH
/
plans
/
{id}
/
items
/
{itemId}
Update a component
curl --request PATCH \
  --url https://billing-api.sandbox.z2pay.com/plans/{id}/items/{itemId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "quantityDefault": 1,
  "quantityIncluded": 1,
  "optional": true,
  "displayOrder": 1,
  "description": "<string>",
  "metadata": {}
}
'

Authorizations

​
x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

​
itemId
string
required

Component (plan_item) ID

​
id
string
required

Plan ID

Body

application/json
​
name
string
Required string length: 1 - 255
​
quantityDefault
integer
Required range: x >= 0
​
quantityIncluded
integer
Required range: x >= 0
​
optional
boolean
​
displayOrder
integer
Required range: x >= 0
​
description
string | null
Maximum string length: 1000
​
metadata
object

Response

Component updated