Recurly Measured Unit API

openapi: 3.2.0
info:
  title: Recurly Measured Unit API
  version: v2021-02-25
  description: 'Operations tagged Measured Unit across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:
- name: Measured Unit
  description: A measured unit describes a usage-based add-on's usage. If different usage-based add-ons share the same measured unit, you can report on customer usage for those add-ons at the aggregated measured unit level.
paths:
  /measured_units:
    get:
      tags:
      - Measured Unit
      operationId: list_measured_unit
      summary: List a site's measured units
      description: See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/ids'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/sort_dates'
      - $ref: '#/components/parameters/filter_begin_time'
      - $ref: '#/components/parameters/filter_end_time'
      - $ref: '#/components/parameters/filter_state'
      responses:
        '200':
          description: A list of the site's measured units.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredUnitList'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    post:
      tags:
      - Measured Unit
      operationId: create_measured_unit
      summary: Create a new measured unit
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasuredUnitCreate'
        required: true
      responses:
        '201':
          description: A new measured unit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredUnit'
        '400':
          description: Bad request, perhaps invalid JSON?
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /measured_units/{measured_unit_id}:
    get:
      tags:
      - Measured Unit
      operationId: get_measured_unit
      summary: Fetch a measured unit
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/measured_unit_id'
      responses:
        '200':
          description: An item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredUnit'
        '404':
          description: Incorrect site or measured unit ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    put:
      tags:
      - Measured Unit
      operationId: update_measured_unit
      summary: Update a measured unit
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/measured_unit_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasuredUnitUpdate'
        required: true
      responses:
        '200':
          description: The updated measured_unit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredUnit'
        '400':
          description: Bad request, perhaps invalid JSON?
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site or measured unit ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    delete:
      tags:
      - Measured Unit
      operationId: remove_measured_unit
      summary: Remove a measured unit
      description: A mesured unit cannot be deleted if it is used by an active plan.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/measured_unit_id'
      responses:
        '200':
          description: A measured unit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredUnit'
        '422':
          description: Measured unit may already be inactive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
components:
  schemas:
    MeasuredUnitCreate:
      type: object
      properties:
        name:
          type: string
          title: Name
          description: Unique internal name of the measured unit on your site.
          maxLength: 255
        display_name:
          type: string
          title: Display name
          description: Display name for the measured unit.
          pattern: /^[\w ]+$/
          maxLength: 50
        description:
          type: string
          title: Description
          description: Optional internal description.
      required:
      - name
      - display_name
    MeasuredUnitUpdate:
      type: object
      properties:
        name:
          type: string
          title: Name
          description: Unique internal name of the measured unit on your site.
          maxLength: 255
        display_name:
          type: string
          title: Display name
          description: Display name for the measured unit.
          pattern: /^[\w ]+$/
          maxLength: 50
        description:
          type: string
          title: Description
          description: Optional internal description.
    ActiveStateEnum:
      type: string
      enum:
      - active
      - inactive
    AlphanumericSortEnum:
      type: string
      enum:
      - asc
      - desc
    ErrorTypeEnum:
      type: string
      enum:
      - bad_request
      - immutable_subscription
      - internal_server_error
      - invalid_api_key
      - invalid_api_version
      - invalid_content_type
      - invalid_permissions
      - invalid_token
      - missing_feature
      - not_found
      - rate_limited
      - service_not_available
      - simultaneous_request
      - tax_service_error
      - transaction
      - unauthorized
      - unavailable_in_api_version
      - unknown_api_version
      - validation
    MeasuredUnit:
      type: object
      title: Measured unit
      properties:
        id:
          type: string
          title: Item ID
          maxLength: 13
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        name:
          type: string
          title: Name
          description: Unique internal name of the measured unit on your site.
        display_name:
          type: string
          title: Display name
          description: Display name for the measured unit. Can only contain spaces, underscores and must be alphanumeric.
          maxLength: 50
        state:
          title: State
          description: The current state of the measured unit.
          readOnly: true
          $ref: '#/components/schemas/ActiveStateEnum'
        description:
          type: string
          title: Description
          description: Optional internal description.
        created_at:
          type: string
          format: date-time
          title: Created at
          readOnly: true
        updated_at:
          type: string
          format: date-time
          title: Last updated at
          readOnly: true
        deleted_at:
          type: string
          format: date-time
          title: Deleted at
          readOnly: true
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    TimestampSortEnum:
      type: string
      enum:
      - created_at
      - updated_at
    Error:
      type: object
      properties:
        type:
          title: Type
          $ref: '#/components/schemas/ErrorTypeEnum'
        message:
          type: string
          title: Message
        params:
          type: array
          title: Parameter specific errors
          items:
            type: object
            properties:
              param:
                type: string
    MeasuredUnitList:
      type: object
      properties:
        object:
          type: string
          title: Object type
          description: Will always be List.
        has_more:
          type: boolean
          description: Indicates there are more results on subsequent pages.
        next:
          type: string
          description: Path to subsequent page of results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/MeasuredUnit'
  parameters:
    filter_begin_time:
      name: begin_time
      in: query
      description: 'Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`.

        **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

        '
      schema:
        type: string
        format: date-time
    ids:
      name: ids
      in: query
      description: "Filter results by their IDs. Up to 200 IDs can be passed at once using\ncommas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.\n\n**Important notes:**\n\n* The `ids` parameter cannot be used with any other ordering or filtering\n  parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)\n* Invalid or unknown IDs will be ignored, so you should check that the\n  results correspond to your request.\n* Records are returned in an arbitrary order. Since results are all\n  returned at once you can sort the records yourself.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    order:
      name: order
      in: query
      description: Sort order.
      schema:
        default: desc
        $ref: '#/components/schemas/AlphanumericSortEnum'
    filter_end_time:
      name: end_time
      in: query
      description: 'Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`.

        **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

        '
      schema:
        type: string
        format: date-time
    filter_state:
      name: state
      in: query
      description: Filter by state.
      schema:
        $ref: '#/components/schemas/ActiveStateEnum'
    measured_unit_id:
      name: measured_unit_id
      in: path
      description: Measured unit ID or name. For ID no prefix is used e.g. `e28zov4fw0v2`. For name use prefix `name-`, e.g. `name-Storage`.
      required: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Limit number of records 1-200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
    accept_header:
      name: Accept
      in: header
      description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`. Requests without a versioned `Accept` header return a 406 response.
      required: true
      schema:
        default: application/vnd.recurly.v2021-02-25
        $ref: '#/components/schemas/AcceptHeaderEnum'
    sort_dates:
      name: sort
      in: query
      description: 'Sort field. You *really* only want to sort by `updated_at` in ascending

        order. In descending order updated records will move behind the cursor and could

        prevent some records from being returned.

        '
      schema:
        default: created_at
        $ref: '#/components/schemas/TimestampSortEnum'
  securitySchemes:
    api_key:
      type: http
      description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
      scheme: basic
x-refined-from:
- recurly-v3-v2021-02-25-api.yaml
- recurly-openapi.yml
x-readme:
  explorer-enabled: false