Plan

Subscription plan management.

Create

Endpoint

POST /plan/create

Authorized User Role

admin

Request Body

Field	Type	Notes
agent	string	Agent.
align	boolean	Align.
end	date	End.
interest	array	Interest.
pending	boolean	Pending.
period	string	Period.
scope	string	Scope.
start	date	Start.
type	string	Type.
units	number	Units.

Response

Field	Type
accountId	string
id	string
advance	boolean
agent	string
align	boolean
count	number
current	object
discount	number
end	date
fixed	boolean
interest	array
lastBilled	date
license	string
memo	string
nextReminder	date
notify	array
override	object
pending	boolean
period	string
prepay	boolean
purchases	array
start	date
scope	string
sliding	boolean
test	number
type	string
units	number

Current

Field	Type
count	number
end	date
license	string
period	string
price	number
scope	string
start	date
units	number
upfront	number

Purchases

Field	Type
date	date
units	number
expired	number

Get

Endpoint

POST /plan/get

Authorized User Role

user

Request Body

Field	Type	Notes
id	string	Plan ID.
type	string	Type.

Response

Field	Type
accountId	string
id	string
advance	boolean
agent	string
align	boolean
count	number
current	object
discount	number
end	date
fixed	boolean
interest	array
lastBilled	date
license	string
memo	string
nextReminder	date
notify	array
override	object
pending	boolean
period	string
prepay	boolean
purchases	array
start	date
scope	string
sliding	boolean
test	number
type	string
units	number

Current

Field	Type
count	number
end	date
license	string
period	string
price	number
scope	string
start	date
units	number
upfront	number

Purchases

Field	Type
date	date
units	number
expired	number

Find

Endpoint

POST /plan/find

Authorized User Role

user

Request Body

Field	Type	Notes
type	string	Type.

Query String Options

Field	Type
filter	string
hidden	boolean
index	string
limit	number
log	boolean
next	object
prev	object
where	string

Response

Paged response.

Field	Type	Notes
data	array	An array of Plan records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Plan

Field	Type
accountId	string
id	string
advance	boolean
agent	string
align	boolean
count	number
current	object
discount	number
end	date
fixed	boolean
interest	array
lastBilled	date
license	string
memo	string
nextReminder	date
notify	array
override	object
pending	boolean
period	string
prepay	boolean
purchases	array
start	date
scope	string
sliding	boolean
test	number
type	string
units	number

Current

Field	Type
count	number
end	date
license	string
period	string
price	number
scope	string
start	date
units	number
upfront	number

Purchases

Field	Type
date	date
units	number
expired	number

Remove

Endpoint

POST /plan/remove

Authorized User Role

admin

Request Body

Field	Type	Notes
id	string	Plan ID.

Response

Field	Type
accountId	string
id	string
advance	boolean
agent	string
align	boolean
count	number
current	object
discount	number
end	date
fixed	boolean
interest	array
lastBilled	date
license	string
memo	string
nextReminder	date
notify	array
override	object
pending	boolean
period	string
prepay	boolean
purchases	array
start	date
scope	string
sliding	boolean
test	number
type	string
units	number

Current

Field	Type
count	number
end	date
license	string
period	string
price	number
scope	string
start	date
units	number
upfront	number

Purchases

Field	Type
date	date
units	number
expired	number

Update

Endpoint

POST /plan/update

Authorized User Role

admin

Request Body

Field	Type	Notes
align	boolean	Align.
end	date	End.
id	string	Plan ID.
interest	array	Interest.
nextReminder	date	Next reminder.
pending	boolean	Pending.
prepay	boolean	Prepay.
period	string	Period.
scope	string	Scope.
start	date	Start.
type	string	Type.
units	number	Units.

Response

Field	Type
accountId	string
id	string
advance	boolean
agent	string
align	boolean
count	number
current	object
discount	number
end	date
fixed	boolean
interest	array
lastBilled	date
license	string
memo	string
nextReminder	date
notify	array
override	object
pending	boolean
period	string
prepay	boolean
purchases	array
start	date
scope	string
sliding	boolean
test	number
type	string
units	number

Current

Field	Type
count	number
end	date
license	string
period	string
price	number
scope	string
start	date
units	number
upfront	number

Purchases

Field	Type
date	date
units	number
expired	number