Get organization prices

GET 
/organizations/organization/prices

Returns the active prices for an organization

Scopes

• organizations:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

organization[id] string

All 'organization[]' params are mutually exclusive, only one can be provided.

organization[sub_domain] string

All 'organization[]' params are mutually exclusive, only one can be provided.

Responses

200

Returns the active prices for an organization

application/json

Schema

Schema

currency

object

required

id string

name string

iso_code string

symbol string

prices

object[]

required

The prices in the default price plan

Array [

resource string

category string

description string

price float

variants

object[]

Array [

id string

description stringnullable

price float

]

]

Example (from schema)

{
  "currency": {
    "id": "string",
    "name": "string",
    "iso_code": "string",
    "symbol": "string"
  },
  "prices": [
    {
      "resource": "string",
      "category": "string",
      "description": "string",
      "price": 0,
      "variants": [
        {
          "id": "string",
          "description": "string",
          "price": 0
        }
      ]
    }
  ]
}

400

400 error response

application/json

Schema

Schema

oneOf

APIAuthenticator400Schema

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string

detail object

PricesNotAvailableForManagedOrganizationsSchema

Managed organizations do not have policies. Make this request on the parent organization instead.

code PricesNotAvailableForManagedOrganizationsEnum (string)

Possible values: [prices_not_available_for_managed_organizations]

description string

detail object

Example (from schema)

{}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

OrganizationSuspendedSchema

An organization was found from the arguments provided but it was suspended

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

An organization was found from the arguments provided but it wasn't activated yet

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

Example (from schema)

{}

404

No organization was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

{
  "code": "organization_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...