Skip to main content
POST
/
plans
/
{id}
/
items
Add a component to the plan bundle
curl --request POST \
  --url https://billing-api.sandbox.z2pay.com/plans/{id}/items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "kind": "recurring",
  "quantityDefault": 1,
  "quantityIncluded": 0,
  "optional": false,
  "displayOrder": 0,
  "description": "<string>",
  "metadata": {}
}
'

Authorizations

​
x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

​
Idempotency-Key
string

Unique key for request idempotency

Path Parameters

​
id
string
required

Plan ID

Body

application/json
​
key
string
required
Required string length: 1 - 100
Pattern: ^[a-z0-9-_]+$
​
name
string
required
Required string length: 1 - 255
​
kind
enum<string>
default:recurring
Available options:
recurring,
activation
​
quantityDefault
integer
default:1
Required range: x >= 0
​
quantityIncluded
integer
default:0
Required range: x >= 0
​
optional
boolean
default:false
​
displayOrder
integer
default:0
Required range: x >= 0
​
description
string
Maximum string length: 1000
​
metadata
object

Response

Component created