Updated Tue May 30th 2023, 17:27 UTC

Account Plans

GET /:account/account_plans

An account can have related “Account Plans” of which the owner has purchased licenses for usage. This gives details regarding those account plan licenses and details regarding them.

Examples

Fetch Account Plan Licenses

Request

GET /textus/account_plans

Example

$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /textus/account_plans
    

Response

Status

200

Response Type

hydra:Collection

Example Body

{
  "@type": "hydra:Collection",
  "@context": "/contexts/hydra:Collection.jsonld",
  "id": "/my_account/account_plans",
  "members": [
    {
      "@type": "AccountPlan",
      "@context": "/contexts/AccountPlan.jsonld",
      "id": "/my_account/account_plans/6NvZNG",
      "name": "Pro Msg Account: Up to 2k Msg/Month",
      "type": "message",
      "shared": false,
      "assignable": true,
      "quantity": 2,
      "size": 2000,
      "effectiveStartDate": "2021-11-15",
      "effectiveEndDate": "2022-09-01",
      "assignments": [
        {
          "account": "/accounts/single-user-account-dev",
          "quantity": 1
        },
        {
          "account": "/accounts/bandwidth-v2-dev",
          "quantity": 1
        }
      ]
    }
  ],
  "totalItems": 2
}

Get
Assign