Plans
Create a new plan
Plans
Create a new plan
POST
/
plans
curl --request POST \
--url https://api.sulu.sh/v0/plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"billingInterval": "monthly",
"currency": "USD",
"tax": {},
"prices": [
"<string>"
]
}'
{
"id": "<string>",
"object": "plan",
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"billingInterval": "<string>",
"currency": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"tax": {},
"prices": [
{
"id": "<string>",
"object": "price",
"billableMetricId": "<string>",
"model": "standard",
"invoiceDisplayName": "<string>",
"properties": {
"unitPrice": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
Plan created successfully
The response is of type object
.
curl --request POST \
--url https://api.sulu.sh/v0/plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"billingInterval": "monthly",
"currency": "USD",
"tax": {},
"prices": [
"<string>"
]
}'
{
"id": "<string>",
"object": "plan",
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"billingInterval": "<string>",
"currency": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"tax": {},
"prices": [
{
"id": "<string>",
"object": "price",
"billableMetricId": "<string>",
"model": "standard",
"invoiceDisplayName": "<string>",
"properties": {
"unitPrice": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}