minimusdocs
Help center

Credits

Get the price of a package for a line

GET/credits/quote/

read Read: looks, changes nothing. Scopes

What you would pay to put this package on a new line, or to extend line with it, and whether you may: refused says why not.

Query parameters

  • linestring (uuid)

    The line to extend; leave out for a new line.

  • packagestring (uuid)required

    The package.

Response

200 OK

  • pricestring (decimal)required

    What the package costs this account.

  • own_pricebooleanrequired

    The price is one set for this account.

  • sourcestringrequired

    Where the price comes from.

    • own - Your own price
    • parent - A price the reseller above you set
    • list - The package's price
  • balancestring (decimal)required
  • balance_afterstring (decimal)required
  • unlimitedbooleanrequired
  • operatorbooleanrequired

    A panel operator: pays nothing.

  • enoughbooleanrequired

    The balance covers the price.

  • missingstring (decimal)required

    What the balance lacks; "0.00" when it is enough.

  • trialobjectrequiredcan be null

    For a trial package on a new line; null otherwise.

    • leftintegerrequiredcan be null

      Trial lines left in the period; null: no limit.

  • refusedstringrequiredcan be null

    Why it would be refused, in words; null: it would not.

  • refused_fieldstringrequiredcan be null

    What the refusal is about.

    • package - package
    • credits - credits
  • next_atstring (date-time)requiredcan be null

    When a trial limit refusal lifts.

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means