Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

Get a customer's agreed rates

GET/v1/organizations/{orgId}/rate-card
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
asOfstring<date>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
organizationIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
servicesobject[]required
Show properties
Array of object
currentRateobject | nullrequired
Show properties
Any of:
object
currencystringrequired
matches ^[A-Z]{3}$
effectiveFromstring<date>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
parametersobjectrequired
Show properties
bundleQuantityinteger
min 1 · max 9007199254740991
includedDaysinteger
min 0 · max 9007199254740991
includedMinutesinteger
min 0 · max 9007199254740991
includedQuantityinteger
min 0 · max 9007199254740991
incrementMinutesinteger
min 1 · max 9007199254740991
launchReservationCreditstring
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
measurementstring
Allowed:daily_observed_volumeperiod_quantity
minimumEligibleboolean
minimumMinutesinteger
min 1 · max 9007199254740991
overageRatestring
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
premiumPolicystring
Allowed:additive_allowedhighest_applicable
roundingstring
Allowed:ceiling_per_itemhalf_up_once
sourceAdjustmentWindowDaysinteger
min 0 · max 9007199254740991
volumeBandsobject[]
min items 1 · max items 20
Show properties
Array of object
fromQuantityintegerrequired
min 0 · max 9007199254740991
ratestringrequired
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
ratestringrequired
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
null
null
customerDescriptionstring | nullrequired
displayNamestringrequired
pricingBasisstring | nullrequired
Show properties
Any of:
string
string
null
null
quantityUnitstring | nullrequired
Show properties
Any of:
string
string
null
null
scheduledRatesobject[]required
Show properties
Array of object
currencystringrequired
matches ^[A-Z]{3}$
effectiveFromstring<date>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
parametersobjectrequired
Show properties
bundleQuantityinteger
min 1 · max 9007199254740991
includedDaysinteger
min 0 · max 9007199254740991
includedMinutesinteger
min 0 · max 9007199254740991
includedQuantityinteger
min 0 · max 9007199254740991
incrementMinutesinteger
min 1 · max 9007199254740991
launchReservationCreditstring
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
measurementstring
Allowed:daily_observed_volumeperiod_quantity
minimumEligibleboolean
minimumMinutesinteger
min 1 · max 9007199254740991
overageRatestring
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
premiumPolicystring
Allowed:additive_allowedhighest_applicable
roundingstring
Allowed:ceiling_per_itemhalf_up_once
sourceAdjustmentWindowDaysinteger
min 0 · max 9007199254740991
volumeBandsobject[]
min items 1 · max items 20
Show properties
Array of object
fromQuantityintegerrequired
min 0 · max 9007199254740991
ratestringrequired
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
ratestringrequired
max length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
serviceCodestringrequired
min length 1 · max length 64 · matches ^[a-z][a-z0-9_]*$
serviceIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
statusstringrequired
Allowed:disabledenabledincluded
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/rate-card' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "asOf": "2019-08-24",
    "organizationId": "string",
    "services": [
      {
        "currentRate": {
          "currency": "string",
          "effectiveFrom": "2019-08-24",
          "parameters": {
            "bundleQuantity": 1,
            "includedDays": 0,
            "includedMinutes": 0,
            "includedQuantity": 0,
            "incrementMinutes": 1,
            "launchReservationCredit": "string",
            "measurement": "daily_observed_volume",
            "minimumEligible": true,
            "minimumMinutes": 1,
            "overageRate": "string",
            "premiumPolicy": "additive_allowed",
            "rounding": "ceiling_per_item",
            "sourceAdjustmentWindowDays": 0,
            "volumeBands": [
              {
                "fromQuantity": 0,
                "rate": "string"
              }
            ]
          },
          "rate": "string"
        },
        "customerDescription": "string",
        "displayName": "string",
        "pricingBasis": "at_cost",
        "quantityUnit": "box",
        "scheduledRates": [
          {
            "currency": "string",
            "effectiveFrom": "2019-08-24",
            "parameters": {
              "bundleQuantity": 1,
              "includedDays": 0,
              "includedMinutes": 0,
              "includedQuantity": 0,
              "incrementMinutes": 1,
              "launchReservationCredit": "string",
              "measurement": "daily_observed_volume",
              "minimumEligible": true,
              "minimumMinutes": 1,
              "overageRate": "string",
              "premiumPolicy": "additive_allowed",
              "rounding": "ceiling_per_item",
              "sourceAdjustmentWindowDays": 0,
              "volumeBands": [
                {
                  "fromQuantity": 0,
                  "rate": "string"
                }
              ]
            },
            "rate": "string"
          }
        ],
        "serviceCode": "string",
        "serviceId": "string",
        "status": "disabled"
      }
    ]
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?