masstack

V2
V3
V4
API Overview Resources Schemas

Terms

Access to terms

Parameters

Name In Type Required Description
orgId path string true organization name
accountId path integer(int64) true account identifier

Request example

1
2
3
4
5


curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/terms \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation [AccountTerms]
400 Bad Request Invalid request body ErrorMessage

200 - instance of AccountTerms

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

[
  {
    "subscription_id": 214748364,
    "start_date": "2017-09-15T22:00:00Z",
    "end_date": "2017-09-15T22:00:00Z",
    "penalty_amount": 0,
    "terms_months": 12,
    "account_bundle_id": 214748364,
    "binding_type": {
      "id": 214748364,
      "value": "12 MESES"
    },
    "promotion": {
      "id": 0,
      "value": "string",
      "description": "PERMANENCIA TERMINAL 150E 24M"
    },
    "associated_type": "terminal",
    "associated_terminal": {
      "id": 0,
      "value": "string"
    }
  }
]
Name Type Required Description
subscription_id integer(int64) false subscription id
start_date string(date-time) false start date
end_date string(date-time) false end date
penalty_amount number(double) false terms penalty amount
terms_months integer(int32) false terms months
account_bundle_id integer(int64) false account bundle id
binding_type BindingType false none
promotion AccountTermsPromotion false none
associated_type string false Type of permanence to which it is associated
associated_terminal AccountTermsAssociatedTerminal false none
Property Values
associated_type one of [terminal, promotion]

Endpoints

Signups

    Users

      Accounts

        Invoices

          Terms

            Payment info

              Account migrations

                Subscriptions

                  Products

                    Services

                      Bonuses

                        Promotions

                          Barrings

                            Consumption

                              Workorders

                                Penalties