Skip to content

Plan

Fields

  • tierp8orp20orp100required
  • modecaporoveragerequired

    cap: never pay more than the plan price; overage: usage past the credit is charged to the card.

  • statusscheduledoractiveorpast_dueorlapsedorcancelledrequired
  • currentPeriodstringrequired

    The calendar month (UTC) the plan is in.

    pattern: ^[0-9]{4}-[0-9]{2}$
  • startsPeriodstringrequired

    The month the plan started, or starts when scheduled.

    pattern: ^[0-9]{4}-[0-9]{2}$
  • pendingTierstringornullrequired

    A lower tier taking effect next month.

    2 variants

    One of the following:

    • string
    • null
  • cancelAtPeriodEndbooleanrequired
  • capSincestringornullrequired

    The hour the cap began counting this month; null in overage mode.

    2 variants

    One of the following:

    • string
    • null
  • creditobjectrequired
    3 properties
    • amountstringrequired

      Credit usable this month.

      pattern: ^[0-9]+\.[0-9]{2}$
    • usedstringrequired

      Usage this month counted against it.

      pattern: ^[0-9]+\.[0-9]{2}$
    • remainingstringrequired
      pattern: ^[0-9]+\.[0-9]{2}$
  • controlsobjectrequired
    2 properties
    • blockedbooleanrequired

      New billable resources are refused.

    • stoppedbooleanrequired

      Running instances were stopped.

  • updatedAtstringrequired
    format: date-time
Navigation

Type to search…

↑↓ navigate↵ selectEsc close