Recurly External Product API

openapi: 3.2.0
info:
  title: Recurly External Product API
  version: v2021-02-25
  description: 'Operations tagged External Product 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 Product
  description: A product 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:
  /external_products:
    get:
      tags:
      - External Product
      operationId: list_external_products
      summary: List a site's external products
      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/sort_dates'
      responses:
        '200':
          description: A list of the the external_products on a site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalProductList'
        '404':
          description: Incorrect 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 Product
      operationId: create_external_product
      summary: Create an external product
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalProductCreate'
        required: true
      responses:
        '201':
          description: Returns the external product
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalProduct'
        '400':
          description: Bad request; perhaps missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: External product cannot be created for the specified reason.
          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
  /external_products/{external_product_id}:
    parameters:
    - $ref: '#/components/parameters/external_product_id'
    get:
      tags:
      - External Product
      operationId: get_external_product
      summary: Fetch an external product
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Settings for an external product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalProduct'
        '404':
          description: Incorrect site or external product 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:
      - External Product
      operationId: update_external_product
      summary: Update an external product
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalProductUpdate'
        required: true
      responses:
        '200':
          description: Settings for an external product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalProduct'
        '404':
          description: Bad request; perhaps missing or invalid 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:
      - External Product
      operationId: deactivate_external_products
      summary: Deactivate an external product
      description: Deactivate an external product.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Deactivated external product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalProduct'
        '404':
          description: Bad request; perhaps missing or invalid 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
components:
  schemas:
    PlanMini:
      type: object
      title: Plan mini details
      description: Just the important parts.
      properties:
        id:
          type: string
          title: Plan ID
          maxLength: 13
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        code:
          $ref: '#/components/schemas/PlanCode'
        name:
          $ref: '#/components/schemas/PlanName'
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    PlanCode:
      type: string
      title: Plan code
      description: Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
      pattern: /^[a-z0-9_+-]+$/
      maxLength: 50
    ExternalProductCreate:
      type: object
      properties:
        name:
          type: string
          description: External product name.
        plan_id:
          type: string
          description: Recurly plan UUID.
        external_product_references:
          type: array
          title: External Product References
          description: List of external product references of the external product.
          items:
            $ref: '#/components/schemas/ExternalProductReferenceBase'
      required:
      - name
    ExternalProductList:
      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/ExternalProduct'
    ExternalProduct:
      type: object
      description: Product from an external resource such as Apple App Store or Google Play Store.
      properties:
        id:
          type: string
          title: External product ID.
          description: System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: Object type
        name:
          type: string
          title: Name
          description: Name to identify the external product in Recurly.
        plan:
          $ref: '#/components/schemas/PlanMini'
        created_at:
          type: string
          format: date-time
          description: When the external product was created in Recurly.
        updated_at:
          type: string
          format: date-time
          description: When the external product was updated in Recurly.
        external_product_references:
          type: array
          title: External Product References
          description: List of external product references of the external product.
          items:
            $ref: '#/components/schemas/ExternalProductReferenceMini'
    TimestampSortEnum:
      type: string
      enum:
      - created_at
      - updated_at
    ExternalProductReferenceMini:
      type: object
      title: External Product Reference details
      description: External Product Reference details
      properties:
        id:
          type: string
          title: External Product ID
          description: System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: object
        reference_code:
          type: string
          title: reference_code
          description: A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
        external_connection_type:
          type: string
          title: external_connection_type
          description: Source connection platform.
        created_at:
          type: string
          format: date-time
          description: When the external product was created in Recurly.
        updated_at:
          type: string
          format: date-time
          description: When the external product was updated in Recurly.
    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
    ExternalProductReferenceBase:
      type: object
      properties:
        reference_code:
          type: string
          description: A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
          maxLength: 255
        external_connection_type:
          $ref: '#/components/schemas/ExternalProductReferenceConnectionType'
    ExternalProductReferenceConnectionType:
      type: string
      description: Represents the connection type. One of the connection types of your enabled App Connectors
    ExternalProductUpdate:
      type: object
      properties:
        plan_id:
          type: string
          description: Recurly plan UUID.
      required:
      - plan_id
    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
    PlanName:
      type: string
      title: Name
      description: This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
      maxLength: 255
  parameters:
    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_product_id:
      name: external_product_id
      in: path
      description: External product id
      required: true
      schema:
        type: string
    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