Recurly External Account API

openapi: 3.2.0
info:
  title: Recurly External Account API
  version: v2021-02-25
  description: 'Operations tagged External Account 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: External Account
  description: An account from an external resource that is not managed by the Recurly platform and instead is managed by third-party platforms like Apple App Store and Google Play Store.
paths:
  /accounts/{account_id}/external_accounts:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - External Account
      operationId: list_account_external_account
      summary: List external accounts for an account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: A list of external accounts on an account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccountList'
        '404':
          description: Incorrect account or external_account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Unavailable API version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Feature not enabled on site
          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:
      - External Account
      operationId: create_account_external_account
      summary: Create an external account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalAccountCreate'
      responses:
        '200':
          description: A representation of the created external_account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccount'
        '404':
          description: Incorrect account or external_account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Unavailable API version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Feature not enabled on site
          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
  /accounts/{account_id}/external_accounts/{external_account_id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/external_account_id'
    get:
      tags:
      - External Account
      operationId: get_account_external_account
      summary: Get an external account for an account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: A external account on an account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccount'
        '404':
          description: Incorrect account or external_account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Unavailable API version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Feature not enabled on site
          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:
      - External Account
      operationId: update_account_external_account
      summary: Update an external account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalAccountUpdate'
      responses:
        '200':
          description: A representation of the updated external_account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccount'
        '404':
          description: Incorrect account or external_account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Unavailable API version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Feature not enabled on site
          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:
      - External Account
      operationId: delete_account_external_account
      summary: Delete an external account for an account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Successful Delete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAccount'
        '404':
          description: External Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: Unavailable API version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Feature not enabled on site
          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:
  parameters:
    account_id:
      name: account_id
      in: path
      description: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
      required: true
      schema:
        type: string
    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'
    external_account_id:
      name: external_account_id
      in: path
      description: External account ID, e.g. `s28zov4fw0cb`.
      required: true
      schema:
        type: string
  schemas:
    ExternalAccount:
      type: object
      title: External Account
      properties:
        object:
          type: string
          default: external_account
        id:
          type: string
          description: UUID of the external_account .
        external_account_code:
          type: string
          description: Represents the account code for the external account.
        external_connection_type:
          type: string
          description: Represents the connection type. One of the connection types of your enabled App Connectors
        created_at:
          type: string
          format: date-time
          description: Created at
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: Last updated at
          readOnly: true
    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
    ExternalAccountList:
      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/ExternalAccount'
    ExternalAccountUpdate:
      type: object
      properties:
        external_account_code:
          type: string
          description: Represents the account code for the external account.
        external_connection_type:
          type: string
          description: Represents the connection type. One of the connection types of your enabled App Connectors
    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
    ExternalAccountCreate:
      type: object
      properties:
        external_account_code:
          type: string
          description: Represents the account code for the external account.
        external_connection_type:
          type: string
          description: Represents the connection type. One of the connection types of your enabled App Connectors
      required:
      - external_account_code
      - external_connection_type
  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