Skip to main content
POST
/
plans
Create plan
curl --request POST \
  --url https://billing-api.sandbox.z2pay.com/plans \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "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

Body

application/json
​
code
string
required
Required string length: 1 - 100
Pattern: ^[a-z0-9-_]+$
​
name
string
required
Required string length: 1 - 255
​
description
string
Maximum string length: 1000
​
metadata
object

Response

Plan created