Skip to main content

Plans

IMPORTANT NOTICE

This Endpoint is unreleased. It wont be available until end of May

Base URL#

All following endpoints operates over the URL of your store: https://your-store.com/

example: https://alephdigital.publica.la/

Endpoints
Create
Retrieve
Update
Delete

Headers#

keyvalue
Content-typeapplication/json
Acceptapplication/json

Create#

POST /api/v1/dashboard/plans

Body parameters#

ParameterTypeDescription.
typestringValid values: recurring, prepaid, Required
namestring
detailsstring
durationnullable, integer
recommendedboolean
privateboolean
assigns_collectionsboolean
concurrency_limitinteger
collectionslist of collections
download_filesboolean
priceslist of prices
free_trialboolean
free_trial_daysboolean

Example of body parameters#

{
"type":"recurring",
"name":"Demo Plan",
"details":"<div><!--block-->This is the description of the Demo Plan</div>",
"duration":null,
"recommended":true,
"private":false,
"assigns_collections":true,
"concurrency_limit":"1",
"collections":[
"Prepaid"
],
"download_files":false,
"prices":{
"ARS":0,
"USD":"1",
"EUR":0,
"MXN":"1",
"COP":0,
"PEN":0,
"CLP":0,
"AUD":0,
"UYU":0,
"BOB":0,
"PYG":0,
"BRL":0,
"INR":0,
"GTQ":0,
"HNL":0
},
"free_trial":true,
"free_trial_days":"15"
}

Responses#

CodeDescriptio
201Object Created
422Validation error, the reason of the error will be described in the response

Update#

PUT /api/v1/dashboard/plans/{plan_id}

Body parameters#

ParameterTypeDescription.
typestringValid values: recurring, prepaid, Required
namestring
detailsstring
durationnullable, integer
recommendedboolean
privateboolean
assigns_collectionsboolean
concurrency_limitinteger
collectionslist of collections
download_filesboolean
customerstring
invoicestring
file_namestring
upload_filefile
priceslist of prices
free_trialboolean
free_trial_daysboolean

Example of body parameters#

{
"type":"recurring",
"name":"Demo Plan",
"details":"<div><!--block-->This is the description of the Demo Plan</div>",
"duration":null,
"recommended":true,
"private":false,
"assigns_collections":true,
"concurrency_limit":"1",
"collections":[
"Prepaid"
],
"download_files":false,
"customer":"",
"invoice":"",
"file_name":"",
"upload_file":false,
"prices":{
"ARS":0,
"USD":"1",
"EUR":0,
"MXN":"1",
"COP":0,
"PEN":0,
"CLP":0,
"AUD":0,
"UYU":0,
"BOB":0,
"PYG":0,
"BRL":0,
"INR":0,
"GTQ":0,
"HNL":0
},
"free_trial":true,
"free_trial_days":"15"
}

Response#

CodeDesctiption
204Object Updated
422Validation error, the reason of the error will be described in the response

Delete#

DELETE /api/v1/dashboard/plans/{plan_id}

Responses#

CodeDescription
200Object deleted
404Object not found