EmbedThis

Appearance

Plan ​

Subscription plan management.

Create ​

Endpoint

POST /plan/create

Authorized User Role

admin

Request Body

Field | Type | Role

  • | - | - agent | string | current | string | support end | date | interest | array | meter | boolean | pending | boolean | period | string | scope | string | start | date | type | string | units | number |

Response

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number

Get ​

Endpoint

POST /plan/get

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - accountId | string | support id | string | type | string |

Response

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number

Init ​

Endpoint

POST /plan/init

Authorized User Role

user

Request Body

A object.

Response

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number

Find ​

Endpoint

POST /plan/find

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - accountId | string | support type | string |

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Paged response.

Field | Type | Notes

  • | - | - data | array | An array of metrics each containing an array of metric with the following properties. 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

An array of Plan items.

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number

Remove ​

Endpoint

POST /plan/remove

Authorized User Role

admin

Request Body

Field | Type

  • | - id | string

Response

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number

Update ​

Endpoint

POST /plan/update

Authorized User Role

admin

Request Body

Field | Type | Role

  • | - | - accountId | string | support align | boolean | current | object | support end | date | id | string | interest | array | hours | number | support meter | boolean | nextReminder | date | pending | boolean | prepay | boolean | period | string | scope | string | start | date | type | string | units | number |

Response

Field | Type

  • | - accountId | string id | string adjustments | array advance | boolean agent | string align | boolean current | object discount | number end | date fixed | boolean interest | array lastBilled | date meter | boolean 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

  • | - end | date start | date period | string price | number scope | string units | number upfront | number

Purchases

An array of Purchases items.

Field | Type

  • | - date | date units | number expired | number