Create External Product

Create an external product

POST/external_products

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the Create External Product action (under external_products).
Fill in the fields below, then reference the result from later steps as {{createExternalProduct.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

namestringrequired

External product name.

plan_idstring

Recurly plan UUID.

external_product_referencesarray<object>

List of external product references of the external product.

reference_codestring

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_typestring

Represents the connection type. One of the connection types of your enabled App Connectors

json

{
  "name": "string",
  "plan_id": "string",
  "external_product_references": [
    {
      "reference_code": "string",
      "external_connection_type": "string"
    }
  ]
}

Response

Returns 201 with an object. Read it in later steps with {{createExternalProduct.response.data.<field>}}.

idstring

System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.

objectstring

namestring

Name to identify the external product in Recurly.

planobject

Just the important parts.

idstring

objectstring

codestring

Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

namestring

This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.

created_atstring (date-time)

When the external product was created in Recurly.

updated_atstring (date-time)

When the external product was updated in Recurly.

external_product_referencesarray<object>

List of external product references of the external product.

idstring

System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.

objectstring

reference_codestring

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_typestring

Source connection platform.

created_atstring (date-time)

When the external product was created in Recurly.

updated_atstring (date-time)

When the external product was updated in Recurly.

json

{
  "id": "string",
  "object": "string",
  "name": "string",
  "plan": {
    "id": "string",
    "object": "string",
    "code": "string",
    "name": "string"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "external_product_references": [
    {
      "id": "string",
      "object": "string",
      "reference_code": "string",
      "external_connection_type": "string",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.

Was this page helpful?