Recurly External Product References API

The external-product-references API from Recurly — 3 operation(s) for external-product-references.

GitHub OpenAPI

Operations 5

GET /external_product_references/{external_product_reference_id} Fetch an external product reference #
GET /external_products/{external_product_id}/external_product_references List external product references #
POST /external_products/{external_product_id}/external_product_references Create an external product reference #
GET /external_products/{external_product_id}/external_product_references/{external_product_reference_id} Fetch an external product reference #
DELETE /external_products/{external_product_id}/external_product_references/{external_product_reference_id} Deactivate an external product reference #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/recurly:recurly-external-product-references-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

recurly-external-product-references-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Recurly V2 External Product References API
  description: '# Getting Started

    Welcome to the reference documentation for Recurly''s XML API v2. Here you will find a complete

    reference for all API v2 operations. If you''re building a new product, or just getting started with Recurly, we recommend

    using our newer JSON API v3. Now let''s get started with API v2. # Authentication

    ##### API Authentication (HTTP Basic)

    Recurly uses HTTP Basic Authentication—your Private API key is securely encrypted by the SSL channel. If you are testing the API calls via the command line with cURL, try:


    ```

    curl -H ''Accept: application/xml'' \

    -H ''X-Api-Version: 2.29'' \

    -H ''Content-Type: application/xml; charset=utf-8'' \

    -u ''[apikey]'' \

    https://[subdomain].recurly.com/v2/accounts

    ```


    Replace `[apikey]` and `[subdomain]` with the appropriate values for your site. ##### Calculating your own authorization header

    Most programming languages encode the authorization header automatically. With HTTP Basic Authentication, the `Authorization` header is a string containing a Base-64 encoded username and password. In the case of Recurly''s API, you need only specify the username as your API key. If your library requires a password, set it to an empty string. ```

    "Authorization": "Basic " + base64_encode(API Key)

    ```


    ##### Additional Request Headers

    **Accept Header**


    Recurly API v2 returns results as XML. Your requests should always include the header requesting the results as XML:


    ```

    Accept: application/xml

    ```


    **Content-Type Header**


    When sending data to Recurly in a POST or PUT request, your request must specify the content type of your request:


    ```

    Content-Type: application/xml; charset=utf-8

    ```


    **X-Api-Version Header**


    When sending data to Recurly, your request should specify the API version you''re attempting to interact with:

    ```

    X-Api-Version: 2.29

    ```

    You learn more about the different versions in the API Versioning section. ##### Public API Key

    Recurly uses two types of API keys: public and private. The Public API key is used by Recurly.js to identify its requests as belonging to your Recurly site. This key can be safely included in Javascript code. Recurly provides each site with one Public Key. The Public API Key can be regenerated on the API Credentials page. ##### Private API Keys


    ###### Treat your Private API Keys like passwords! The API key allows access to your site''s data. Do not include it in Javascript code exposed to browsers. Recurly supports the use of multiple Private API keys, which can be used to integrate third party services using unique, controlled credentials. **Limits & Pricing**


    Merchants on the Starter or grandfathered Recurly plans or merchants in sandbox mode will be granted 5 private API keys. Merchants on Recurly''s Professional plan will be granted 10 private API keys. **Default Key**


    Your default private API key should be used to integrate Recurly with your backend systems. There will be at least one key active at all times. **Additional Keys**


    Additional private API keys should be used to connect your Recurly data to additional sources, like analytics software, accounting packages, or email tools. Recurly recommends clearly labeling the name of each key to identify the associated vendor. **Regenerating Private API Keys**


    Your API key can be regenerated by clicking on the Regenerate button on the API credentials page. When you generate a private API key, you have two options:


    1. Block the old key immediately. This is primarily recommended when the security of a key has been compromised. 2. Allow the old key access for 12 hours. This is primarily used when updating systems and a smooth transition between keys is needed. *If a private API key is changed, an email alert will be sent to your Recurly Site Technical Contact.*


    **Read-Only Keys**


    When creating a private key, you will have the option to set the key to “read-only”. This means the API key may make GET requests but cannot not PUT, POST or DELETE requests.'
  version: '2.29'
servers:
- url: https://{subdomain}.{domain}/v2
  variables:
    subdomain:
      description: Subdomain of your Recurly site.
      default: my-super-successful-company
    domain:
      description: Domain of your Recurly site.
      default: recurly.com
security:
- api_key: []
tags:
- name: external-product-references
  x-displayName: External Product References
paths:
  /external_product_references/{external_product_reference_id}:
    parameters:
    - $ref: '#/components/parameters/external_product_reference_id'
    get:
      tags:
      - external-product-references
      operationId: getExternalProductReference
      summary: Fetch an external product reference
      responses:
        '200':
          description: Details for an external product reference.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ExternalProductReference'
              example: "<external_product_reference>\n  <id>su3f3uw6lj44</id>\n  <reference_code>new reference_code2</reference_code>\n  <external_connection_type>google_play_store</external_connection_type>\n  <created_at type=\"datetime\">2023-05-04T17:01:17Z</created_at>\n  <updated_at type=\"datetime\">2023-05-08T20:59:35Z</updated_at>\n</external_product_reference>"
        '404':
          description: Incorrect site or external product reference ID.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
              example: "<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find ExternalProductReference with id</description>\n</error>"
        default:
          description: Unexpected error.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
  /external_products/{external_product_id}/external_product_references:
    parameters:
    - $ref: '#/components/parameters/external_product_id'
    get:
      tags:
      - external-product-references
      operationId: listExternalProductExternalProductReference
      summary: List external product references
      responses:
        '200':
          description: Details for all external product references.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ExternalProductReference'
              example: "<external_product_references type=\"array\">\n  <external_product_reference>\n    <id>su3f3uw6lj44</id>\n    <reference_code>new reference_code2</reference_code>\n    <external_connection_type>google_play_store</external_connection_type>\n    <created_at type=\"datetime\">2023-05-04T17:01:17Z</created_at>\n    <updated_at type=\"datetime\">2023-05-08T20:59:35Z</updated_at>\n  </external_product_reference>\n</external_product_references>"
        '404':
          description: Incorrect site or external product ID.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
              example: "<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find ExternalProduct with id</description>\n</error>"
        default:
          description: Unexpected error.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
      - lang: PHP
        source: "<?php\ntry {\n  $external_product = new Recurly_ExternalProduct();\n  $external_product->uuid = 'swifdu8c9om9';\n  $external_product_references = $external_product->listExternalProductReferences();\n  foreach ($external_product_references as $external_product_reference) {\n    print \"External Product Reference: $external_product_reference->reference_code\\n\";\n  }\n} catch (Recurly_ValidationError $e) {\n  print \"Validation error: $e\";\n} catch (Recurly_Error $e) {\n  // Could not find external product\n  print \"Bad request: $e\";\n}"
      - lang: Ruby
        source: 'external_product = Recurly::ExternalProduct.find(''pbux7jvmauhe'')

          external_product_references = external_product.get_external_product_references'
      - lang: Python
        source: 'external_product = recurly.ExternalProduct.get("pbux7jvmauhe")

          external_product_references = external_product.external_product_references'
      - lang: Dotnet
        source: 'var externalProduct = ExternalProduct.Get("pbux7jvmauhe");

          var external_product_reference = externalProduct.GetExternalProductReferences();'
    post:
      tags:
      - external-product-references
      operationId: createExternalProductExternalProductReference
      summary: Create an external product reference
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ExternalProductReferenceCreate'
        required: true
      responses:
        '201':
          description: Details for an external product reference.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ExternalProductReference'
              example: "<external_product_reference>\n  <id>su3f3uw6lj44</id>\n  <reference_code>new reference_code2</reference_code>\n  <external_connection_type>google_play_store</external_connection_type>\n  <created_at type=\"datetime\">2023-05-04T17:01:17Z</created_at>\n  <updated_at type=\"datetime\">2023-05-08T20:59:35Z</updated_at>\n</external_product_reference>"
        '404':
          description: Incorrect site or external product ID.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
              example: "<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find ExternalProduct with id</description>\n</error>"
        default:
          description: Unexpected error.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
      - lang: PHP
        source: "<?php\ntry {\n  $external_product = new Recurly_ExternalProduct();\n  $external_product->uuid = 'swarj00syoa9';\n  $external_product_reference = new Recurly_ExternalProductReference();\n  $external_product_reference->reference_code = 'reference_code2';\n  $external_product_reference->external_connection_type = 'apple_app_store';\n  $external_product->createExternalProductReference($external_product_reference);\n  print \"External Product Reference created: $external_product_reference\\n\";\n} catch (Recurly_ValidationError $e) {\n  print \"Invalid External Product Reference data: $e\";\n}"
      - lang: Ruby
        source: "external_product = Recurly::ExternalProduct.find('pbux7jvmauhe')\nnew_external_product_reference = Recurly::ExternalProductReference.new(\n  external_connection_type: 'apple_app_store',\n  reference_code: 'abcd'\n)\nexternal_product.create_external_product_reference(new_external_product_reference)"
      - lang: Python
        source: 'external_product = recurly.ExternalProduct.get(''pbux7jvmauhe'')

          external_product_reference = recurly.ExternalProductReference()

          external_product_reference.external_connection_type = ''google_play_store''

          external_product_reference.reference_code = ''abcd''

          external_product.create_external_product_reference(external_product_reference)'
      - lang: Dotnet
        source: 'var externalProduct = ExternalProduct.Get(''pbux7jvmauhe'');

          var externalProductReference = new ExternalProductReference();

          externalProductReference.ExternalConnectionType = ''google_play_store'';

          externalProductReference.ReferenceCode = ''abcd'';

          externalProduct.CreateExternalProductReference(externalProductReference);'
  /external_products/{external_product_id}/external_product_references/{external_product_reference_id}:
    parameters:
    - $ref: '#/components/parameters/external_product_id'
    - $ref: '#/components/parameters/external_product_reference_id'
    get:
      tags:
      - external-product-references
      operationId: getExternalProductExternalProductReference
      summary: Fetch an external product reference
      responses:
        '200':
          description: Details for an external product reference.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ExternalProductReference'
              example: "<external_product_reference>\n  <id>su3f3uw6lj44</id>\n  <reference_code>new reference_code2</reference_code>\n  <external_connection_type>google_play_store</external_connection_type>\n  <created_at type=\"datetime\">2023-05-04T17:01:17Z</created_at>\n  <updated_at type=\"datetime\">2023-05-08T20:59:35Z</updated_at>\n</external_product_reference>"
        '404':
          description: Incorrect site or external product reference ID.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
              example: "<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find ExternalProductReference with id</description>\n</error>"
        default:
          description: Unexpected error.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
      - lang: PHP
        source: "<?php\ntry {\n  $external_product = new Recurly_ExternalProduct();\n  $external_product->uuid = 'swifdu8c9om9';\n  $external_product_reference = $external_product->getExternalProductReference(\"swifdua3cvtp\");\n  print \"External Product Reference: $external_product_reference->reference_code\\n\";\n} catch (Recurly_ValidationError $e) {\n  print \"Validation error: $e\";\n} catch (Recurly_Error $e) {\n  // Could not find external product\n  print \"Bad request: $e\";\n}"
      - lang: Ruby
        source: 'external_product = Recurly::ExternalProduct.find(''pbux7jvmauhe'')

          external_product_reference = external_product.get_external_product_reference(''pbux7jvmauhe'')'
      - lang: Python
        source: 'external_product = recurly.ExternalProduct.get("pbux7jvmauhe")

          external_product_reference = external_product.get_external_product_reference("pbux7jvmauhe")'
      - lang: Dotnet
        source: 'var externalProduct = ExternalProduct.Get("pbux7jvmauhe");

          var external_product_reference = externalProduct.GetExternalProductReference("pbux7jvmauhe");'
    delete:
      tags:
      - external-product-references
      operationId: deleteExternalProductExternalProductReference
      summary: Deactivate an external product reference
      responses:
        '204':
          description: No content.
        '404':
          description: Incorrect site or external product reference ID.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
              example: "<error>\n  <symbol>not_found</symbol>\n  <description lang=\"en-US\">Couldn't find ExternalProductReference with id</description>\n</error>"
        default:
          description: Unexpected error.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
      - lang: PHP
        source: "<?php\ntry {\n  $external_product = new Recurly_ExternalProduct();\n  $external_product->uuid = 'swarj00syoa9';\n  $external_product->deleteExternalProductReference('swas4dl5xp3z');\n  print \"ExternalProductReference swas4dl5xp3z removed\" . PHP_EOL;\n} catch (Recurly_ValidationError $e) {\n  print \"Validation error: $e\";\n} catch (Recurly_Error $e) {\n  // Could not find external product\n  print \"Bad request: $e\";\n}"
      - lang: Ruby
        source: 'external_product = Recurly::ExternalProduct.find(''pbux7jvmauhe'')

          external_product_reference = external_product.get_external_product_reference(''pbux7jvmasdf'')

          external_product_reference.destroy!'
      - lang: Python
        source: 'external_product = recurly.ExternalProduct.get("pbux7jvmauhe")

          external_product_reference = external_product.get_external_product_reference("pbux7jvmauhe")

          external_product_reference.delete()'
      - lang: Dotnet
        source: 'var externalProduct = ExternalProduct.Get("pbux7jvmauhe");

          externalProduct.DeleteExternalProductReference("pbux7jvmauhe");'
components:
  schemas:
    ExternalProductReference:
      type: object
      properties:
        id:
          type: string
          description: System-generated unique identifier for an external product reference.
        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.
        external_connection_type:
          type: string
          description: Source connection platform.
        created_at:
          type: string
          format: date-time
          description: When the external product reference was created in Recurly.
        updated_at:
          type: string
          format: date-time
          description: When the external product reference was updated in Recurly.
    ExternalProductReferenceCreate:
      allOf:
      - $ref: '#/components/schemas/ExternalProductReferenceBase'
      required:
      - reference_code
      - external_connection_type
    Error:
      type: object
      title: Error
      properties:
        symbol:
          type: string
        description:
          type: string
      xml:
        name: error
    ExternalProductReferenceConnectionTypeEnum:
      type: string
      enum:
      - apple_app_store
      - google_play_store
    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/ExternalProductReferenceConnectionTypeEnum'
  parameters:
    external_product_id:
      name: external_product_id
      in: path
      description: External product ID, e.g. `e28zov4fw0v2`.
      required: true
      schema:
        type: string
    external_product_reference_id:
      name: external_product_reference_id
      in: path
      description: External product reference ID, e.g. `d39iun2fw1v4`.
      required: true
      schema:
        type: string
  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