Recurly Performance Obligations API

openapi: 3.2.0
info:
  title: Recurly Performance Obligations API
  version: v2021-02-25
  description: 'Operations tagged Performance Obligations 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: Performance Obligations
  description: 'A performance obligation is a promise to provide a distinct good or

    service or a series of distinct goods or services as defined by the revenue standard.

    Performance obligations are completed and revenue is recognized either at a point in

    time or over a period of time, depending on the type of obligation.

    - Point in time a company has to go through the criteria and determine if a performance

    obligation is satisfied over time. If it does not meet those criteria, then the performance

    obligation is satisfied and revenue recognized at the point in time when control of the good

    or service is transferred to the customer.

    - Over a period of time a performance obligation is satisfied and revenue is recognized over

    time if at least one of the following are met:

    - The customer receives and consumes the benefits of the goods or services as they are provided

    by the entity (routine, recurring services like a cleaning service are an example of a series of

    services that are substantially the same and have the same pattern of transfer)'
paths:
  /performance_obligations/{performance_obligation_id}:
    get:
      tags:
      - Performance Obligations
      operationId: get_performance_obligation
      summary: Get a single Performance Obligation
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/performance_obligation_id'
      responses:
        '200':
          description: A single Performance Obligation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformanceObligation'
        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
  /performance_obligations:
    get:
      tags:
      - Performance Obligations
      operationId: get_performance_obligations
      summary: Get a site's Performance Obligations
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: A list of Performance Obligations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformanceObligationList'
        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:
    PerformanceObligation:
      type: object
      description: Performance obligation details
      properties:
        id:
          type: string
          title: Performance Obligation ID
          description: 'The ID of a performance obligation. Performance obligations are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        name:
          title: Performance Obligation Name
          type: string
        created_at:
          title: Created At
          type: string
          readOnly: true
          format: date-time
        updated_at:
          title: Last updated at
          type: string
          readOnly: true
          format: date-time
    PerformanceObligationList:
      type: object
      description: List of Performance Obligations
      properties:
        object:
          title: Object type
          type: string
        has_more:
          type: boolean
          description: Indicates there are more results on subsequent pages.
        next:
          type: string
          description: Path to subsequent page of results.
        data:
          title: Performance Obligation
          type: array
          items:
            $ref: '#/components/schemas/PerformanceObligation'
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    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
    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
  parameters:
    performance_obligation_id:
      name: performance_obligation_id
      in: path
      description: Performance Obligation id.
      required: true
      schema:
        type: string
        title: Performance Obligation ID
        description: 'The ID of a performance obligation. Performance obligations are

          only accessible as a part of the Recurly RevRec Standard and

          Recurly RevRec Advanced features.

          '
        maxLength: 13
    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'
  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