---
updatedAt: 2026-05-05T20:25:41.000Z
agentTools:
  siteIndex: https://docs.recurly.com/llms.txt
  projectIndex: https://docs.recurly.com/recurly-commerce/llms.txt
---

# Get Subscription Line

Get subscription line by id

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/subscriptionLines/{id}": {
      "get": {
        "operationId": "getSubscriptionLine",
        "summary": "Get Subscription Line",
        "description": "Get subscription line by id",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The id of the subscription line",
            "schema": {
              "example": "subscription-line-id",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved subscription line",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionLineDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "tags": [
          "SubscriptionLines API"
        ]
      }
    }
  },
  "info": {
    "title": "Recurly Commerce API Documentation",
    "description": "Recurly Commerce API Documentation",
    "version": "1.3",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://subs.api.recurlycommerce.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "ProductForVariantDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "externalId": {
            "type": "string",
            "description": "The shopify product ID"
          },
          "imageUrl": {
            "type": "string",
            "nullable": true
          },
          "productTitle": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "externalId",
          "imageUrl",
          "productTitle",
          "description"
        ]
      },
      "SubscriptionOfferOptionDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "externalId": {
            "type": "string",
            "description": "The shopify selling plan ID"
          },
          "type": {
            "type": "string",
            "enum": [
              "ONETIME_AND_SUBSCRIPTION",
              "ONE_TIME_AND_PREPAID_SUBSCRIPTION",
              "SUBSCRIPTION_ONLY",
              "PREPAID_SUBSCRIPTION_ONLY",
              "ONETIME_AND_SUBSCRIPTION_AND_PREPAID",
              "SUBSCRIPTION_AND_PREPAID",
              "MEMBERSHIP"
            ],
            "nullable": true
          },
          "name": {
            "type": "string"
          },
          "deliveryCadenceCount": {
            "type": "number"
          },
          "deliveryCadenceUnit": {
            "type": "string",
            "enum": [
              "HOUR",
              "DAY",
              "MONTH",
              "WEEK",
              "YEAR"
            ]
          },
          "billingCadenceCount": {
            "type": "number"
          },
          "billingCadenceUnit": {
            "type": "string",
            "enum": [
              "HOUR",
              "DAY",
              "MONTH",
              "WEEK",
              "YEAR"
            ]
          },
          "discount": {
            "type": "number"
          },
          "discountModifier": {
            "type": "string",
            "enum": [
              "PERCENTAGE",
              "AMOUNT",
              "FIXED_AMOUNT"
            ]
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "externalId",
          "type",
          "name",
          "deliveryCadenceCount",
          "deliveryCadenceUnit",
          "billingCadenceCount",
          "billingCadenceUnit",
          "discount",
          "discountModifier",
          "archived"
        ]
      },
      "SubscriptionOfferDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "externalId": {
            "type": "string",
            "description": "The shopify selling plan group ID"
          },
          "type": {
            "type": "string",
            "enum": [
              "ONETIME_AND_SUBSCRIPTION",
              "ONE_TIME_AND_PREPAID_SUBSCRIPTION",
              "SUBSCRIPTION_ONLY",
              "PREPAID_SUBSCRIPTION_ONLY",
              "ONETIME_AND_SUBSCRIPTION_AND_PREPAID",
              "SUBSCRIPTION_AND_PREPAID",
              "MEMBERSHIP"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "ARCHIVED",
              "DRAFT"
            ]
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "subscriptionOfferOptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionOfferOptionDto"
            }
          },
          "cancellationFlowId": {
            "type": "string",
            "nullable": true,
            "description": "The ID of the associated cancellation flow, if any"
          },
          "trialDurationValue": {
            "type": "number",
            "nullable": true
          },
          "trialDurationUnit": {
            "type": "string",
            "enum": [
              "DAYS",
              "WEEKS",
              "MONTHS",
              "YEARS"
            ],
            "nullable": true
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "externalId",
          "type",
          "status",
          "name",
          "description",
          "subscriptionOfferOptions",
          "trialDurationValue",
          "trialDurationUnit"
        ]
      },
      "VariantDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "externalId": {
            "type": "string",
            "description": "The shopify variant ID"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DELETED"
            ]
          },
          "currentPrice": {
            "type": "number"
          },
          "variantTitle": {
            "type": "string"
          },
          "sku": {
            "type": "string",
            "nullable": true
          },
          "requiresShipping": {
            "type": "boolean"
          },
          "product": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductForVariantDto"
              }
            ]
          },
          "subscriptionOffer": {
            "$ref": "#/components/schemas/SubscriptionOfferDto"
          }
        },
        "required": [
          "id",
          "externalId",
          "status",
          "currentPrice",
          "variantTitle",
          "sku",
          "requiresShipping"
        ]
      },
      "SubscriptionLineScheduleDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "deliveryInterval": {
            "type": "number",
            "description": "The frequency multiplier that determines how often an add-on product is included with deliveries. Values: 1 (every delivery), 2 (every other delivery), 3 (every third delivery), etc"
          },
          "deliveryStartOffset": {
            "type": "number",
            "description": "How many orders to skip before starting the delivery cadence"
          },
          "lastIncludedOrderNumber": {
            "type": "number"
          },
          "lastIncludedDate": {
            "format": "date-time",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "id",
          "deliveryInterval",
          "deliveryStartOffset",
          "lastIncludedOrderNumber",
          "lastIncludedDate",
          "createdAt",
          "updatedAt"
        ]
      },
      "CustomAttribute": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "BundleItemDto": {
        "type": "object",
        "properties": {
          "variant": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/VariantDto"
              }
            ]
          },
          "quantity": {
            "type": "number"
          },
          "currentPrice": {
            "type": "number"
          }
        },
        "required": [
          "variant",
          "quantity",
          "currentPrice"
        ]
      },
      "SubscriptionLineDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "externalId": {
            "type": "string",
            "description": "The shopify contract line ID"
          },
          "subscriptionId": {
            "type": "string"
          },
          "variant": {
            "$ref": "#/components/schemas/VariantDto"
          },
          "quantity": {
            "type": "number"
          },
          "currentPrice": {
            "type": "number"
          },
          "subscriptionOfferOptionId": {
            "type": "string",
            "nullable": true
          },
          "sellingPlanId": {
            "type": "string",
            "nullable": true,
            "description": "The shopify selling plan ID of the subscription offer option"
          },
          "productFulfillmentTypeRestriction": {
            "type": "string",
            "enum": [
              "PHYSICAL_ONLY",
              "DIGITAL_ONLY"
            ],
            "nullable": true,
            "description": "Fulfillment type restriction declared on the subscription offer, if any"
          },
          "schedule": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/SubscriptionLineScheduleDto"
              }
            ]
          },
          "customAttributes": {
            "nullable": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomAttribute"
            }
          },
          "bundleItems": {
            "nullable": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BundleItemDto"
            }
          },
          "deletedAt": {
            "format": "date-time",
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "externalId",
          "subscriptionId",
          "variant",
          "quantity",
          "currentPrice",
          "subscriptionOfferOptionId",
          "sellingPlanId",
          "productFulfillmentTypeRestriction",
          "schedule",
          "customAttributes"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```

# Sibling pages

* [List Subscription Lines](https://docs.recurly.com/recurly-commerce/reference/listsubscriptionlines.md)
* [Create Subscription Line](https://docs.recurly.com/recurly-commerce/reference/createsubscriptionline.md)
* [Delete Subscription Line](https://docs.recurly.com/recurly-commerce/reference/deletesubscriptionline.md)
* [Create Subscription Line Schedule](https://docs.recurly.com/recurly-commerce/reference/createsubscriptionlineschedule.md)
* [Update Subscription Line Schedule](https://docs.recurly.com/recurly-commerce/reference/updatesubscriptionlineschedule.md)
* [Delete Subscription Line Schedule](https://docs.recurly.com/recurly-commerce/reference/deletesubscriptionlineschedule.md)
* [Update Subscription Line Custom Attributes](https://docs.recurly.com/recurly-commerce/reference/updatesubscriptionlinecustomattributes.md)
* [Swap Subscription Line](https://docs.recurly.com/recurly-commerce/reference/swapsubscriptionline.md)
* [Update Subscription Line Price](https://docs.recurly.com/recurly-commerce/reference/updatesubscriptionlineprice.md)
* [Update Subscription Line Quantity](https://docs.recurly.com/recurly-commerce/reference/updatesubscriptionlinequantity.md)