--- updatedAt: 2026-05-05T20:25:41.000Z agentTools: siteIndex: https://docs.recurly.com/llms.txt projectIndex: https://docs.recurly.com/recurly-commerce/llms.txt --- # List Subscriptions By Subscriber Get subscriptions by subscriber # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/api/v1/subscribers/{id}/subscriptions": { "get": { "operationId": "listSubscriptionsBySubscriber", "summary": "List Subscriptions By Subscriber", "description": "Get subscriptions by subscriber", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "The id of the subscriber", "schema": { "example": "subscriber-id", "type": "string" } }, { "name": "page", "required": true, "in": "query", "description": "Page number", "schema": { "default": 1, "type": "number" } }, { "name": "limit", "required": true, "in": "query", "description": "Items per page. Limit must be between 1 and 250.", "schema": { "default": 10, "type": "number" } }, { "name": "sort", "required": false, "in": "query", "description": "Sort order. If not set, default is createdAt.", "schema": { "type": "string" } }, { "name": "desc", "required": false, "in": "query", "description": "Sort direction. If not set, default is ASC.", "schema": { "type": "boolean" } }, { "name": "minCreatedAt", "required": false, "in": "query", "description": "The min date of createdAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "maxCreatedAt", "required": false, "in": "query", "description": "The max date of createdAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "minUpdatedAt", "required": false, "in": "query", "description": "The min date of updatedAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "maxUpdatedAt", "required": false, "in": "query", "description": "The min date of updatedAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "includeDeleted", "required": false, "in": "query", "description": "If true, include deleted lines", "schema": { "default": false, "type": "boolean" } }, { "name": "subscriptionId", "required": false, "in": "query", "description": "The subscription ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved subscriptions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDto" } } } } } }, "security": [ { "bearer": [] } ], "tags": [ "Subscribers 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": { "SubscriberDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string", "description": "The date the shopper record was created in the Commerce system. This is merchant-agnostic and may predate when the shopper first subscribed to your store." }, "relationshipStartedAt": { "format": "date-time", "type": "string", "nullable": true, "description": "The date the relationship between this shopper and your store began (e.g. their first subscription). Null if unknown, e.g. gift recipients without a direct relationship." }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify id of the subscriber" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string" }, "phoneCountryCode": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "required": [ "id", "createdAt", "relationshipStartedAt", "updatedAt", "externalId", "firstName", "lastName", "email", "phoneCountryCode", "phone" ] }, "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" ] }, "OneTimeAddOnDto": { "type": "object", "properties": { "id": { "type": "string" }, "variantId": { "type": "string" }, "quantity": { "type": "number" }, "modifierType": { "type": "string", "enum": [ "PERCENTAGE", "AMOUNT", "FIXED_AMOUNT" ] }, "discount": { "type": "number" }, "variantPriceOverride": { "type": "number" }, "discountedVariantPrice": { "type": "number", "description": "Calculated price after applying discount" } }, "required": [ "id", "variantId", "quantity" ] }, "UpcomingOrderDto": { "type": "object", "properties": { "scheduledDate": { "format": "date-time", "type": "string" }, "isSkipped": { "type": "boolean" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLineDto" } }, "oneTimeAddOns": { "type": "array", "items": { "$ref": "#/components/schemas/OneTimeAddOnDto" } } }, "required": [ "scheduledDate", "isSkipped", "lines", "oneTimeAddOns" ] }, "SubscriptionGiftDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "numberOfDeliveries": { "type": "number" }, "to": { "type": "string" }, "email": { "type": "string" }, "message": { "type": "string" }, "isOpened": { "type": "boolean" }, "isPrepaid": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "numberOfDeliveries", "to", "email", "message", "isOpened", "isPrepaid" ] }, "SubscriptionDiscountCodeDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "description": "The id of the subscription" }, "code": { "type": "string", "description": "The discount code" }, "discountCodeExternalId": { "type": "string", "description": "The shopify id of the discount code" }, "type": { "type": "string", "enum": [ "MANUAL", "CODE_DISCOUNT", "AUTOMATIC_DISCOUNT" ] }, "targetType": { "type": "string", "enum": [ "SHIPPING_LINE", "LINE_ITEM" ] }, "discountModifier": { "type": "string", "enum": [ "PERCENTAGE", "FIXED_AMOUNT" ] }, "discount": { "type": "number" }, "recurringCycleLimit": { "type": "number" }, "usageCount": { "type": "number" } }, "required": [ "id", "createdAt", "updatedAt", "deletedAt", "subscriptionId", "code", "discountCodeExternalId", "type", "targetType", "discountModifier", "discount", "usageCount" ] }, "DunningInstanceDto": { "type": "object", "properties": { "createdAt": { "format": "date-time", "type": "string" }, "dunningComplete": { "type": "boolean" }, "lastRetryDate": { "format": "date-time", "type": "string" }, "billingRetryCount": { "type": "number" }, "maxBillingRetryCount": { "type": "number" }, "errorCode": { "type": "string" }, "isReactivated": { "type": "boolean" }, "contractCancelledAt": { "format": "date-time", "type": "string" }, "maxBillingRetryCountAction": { "type": "string" } }, "required": [ "createdAt", "dunningComplete", "lastRetryDate", "billingRetryCount", "maxBillingRetryCount", "errorCode", "isReactivated", "contractCancelledAt", "maxBillingRetryCountAction" ] }, "SubscriptionDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "friendlyId": { "type": "string" }, "externalId": { "type": "string", "description": "The shopify contract ID of the subscription" }, "subscriber": { "$ref": "#/components/schemas/SubscriberDto" }, "purchaseDate": { "format": "date-time", "type": "string" }, "trialEndsAt": { "format": "date-time", "type": "string", "nullable": true }, "cancelDate": { "format": "date-time", "type": "string", "nullable": true }, "cancelReason": { "type": "string", "nullable": true }, "pausedAtDate": { "format": "date-time", "type": "string", "nullable": true }, "pauseLimitSettings": { "type": "object", "nullable": true }, "nextDeliveryDate": { "format": "date-time", "type": "string", "nullable": true }, "nextBillingDate": { "format": "date-time", "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "EXPIRED", "CANCELLED", "FAILED" ] }, "deliveryCadenceCount": { "type": "number" }, "deliveryCadenceUnit": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "WEEK", "YEAR" ] }, "billingCadenceCount": { "type": "number" }, "billingCadenceUnit": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "WEEK", "YEAR" ] }, "isPrepaid": { "type": "boolean" }, "isMembership": { "type": "boolean" }, "currencyCode": { "type": "string" }, "deliveryFirstName": { "type": "string", "nullable": true }, "deliveryLastName": { "type": "string", "nullable": true }, "deliveryAddress1": { "type": "string", "nullable": true }, "deliveryAddress2": { "type": "string", "nullable": true }, "deliveryCountry": { "type": "string", "nullable": true }, "deliveryProvince": { "type": "string", "nullable": true }, "deliveryCity": { "type": "string", "nullable": true }, "deliveryZip": { "type": "string", "nullable": true }, "deliveryShippingOption": { "type": "string", "nullable": true }, "deliveryPrice": { "type": "number", "nullable": true }, "deliveryPhone": { "type": "string", "nullable": true }, "deliveryCompany": { "type": "string", "nullable": true }, "billingFirstName": { "type": "string", "nullable": true }, "billingLastName": { "type": "string", "nullable": true }, "billingAddress1": { "type": "string", "nullable": true }, "billingAddress2": { "type": "string", "nullable": true }, "billingCountry": { "type": "string", "nullable": true }, "billingProvince": { "type": "string", "nullable": true }, "billingCity": { "type": "string", "nullable": true }, "billingZip": { "type": "string", "nullable": true }, "paymentMethodExternalId": { "type": "string", "description": "The shopify payment method card ID" }, "paymentMethodType": { "type": "string", "description": "The payment method card type", "enum": [ "CustomerCreditCard", "CustomerPaypalBillingAgreement", "CustomerShopPayAgreement" ], "default": "CustomerCreditCard" }, "paymentMethodLast4Digits": { "type": "string", "description": "The payment method last 4 digits", "nullable": true }, "paymentMethodExpiryMonth": { "type": "string", "description": "The payment method expiry month", "nullable": true }, "paymentMethodExpiryYear": { "type": "string", "description": "The payment method expiry year", "nullable": true }, "paymentMethodBrand": { "type": "string", "description": "The payment method card brand", "nullable": true }, "paymentMethodEmail": { "type": "string", "description": "The payment method email (only shows for paypal payment type)", "nullable": true }, "paymentMethodName": { "type": "string", "description": "The payment method name", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLineDto" } }, "upcomingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/UpcomingOrderDto" } }, "customAttributes": { "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" } }, "gift": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/SubscriptionGiftDto" } ] }, "recipient": { "nullable": true, "description": "The gift recipient", "allOf": [ { "$ref": "#/components/schemas/SubscriberDto" } ] }, "discountCodes": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDiscountCodeDto" } }, "dunningInstances": { "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/DunningInstanceDto" } } }, "required": [ "id", "createdAt", "updatedAt", "friendlyId", "externalId", "subscriber", "purchaseDate", "trialEndsAt", "cancelDate", "cancelReason", "pausedAtDate", "pauseLimitSettings", "nextDeliveryDate", "nextBillingDate", "status", "deliveryCadenceCount", "deliveryCadenceUnit", "billingCadenceCount", "billingCadenceUnit", "isPrepaid", "isMembership", "currencyCode", "deliveryFirstName", "deliveryLastName", "deliveryAddress1", "deliveryAddress2", "deliveryCountry", "deliveryProvince", "deliveryCity", "deliveryZip", "deliveryShippingOption", "deliveryPrice", "deliveryPhone", "deliveryCompany", "billingFirstName", "billingLastName", "billingAddress1", "billingAddress2", "billingCountry", "billingProvince", "billingCity", "billingZip", "paymentMethodExternalId", "paymentMethodType", "paymentMethodLast4Digits", "paymentMethodExpiryMonth", "paymentMethodExpiryYear", "paymentMethodBrand", "paymentMethodEmail", "paymentMethodName", "lines", "upcomingOrders", "customAttributes", "gift", "recipient", "discountCodes", "dunningInstances" ] } } }, "x-readme": { "explorer-enabled": false } } ``` # Sibling pages * [List Subscribers](https://docs.recurly.com/recurly-commerce/reference/listsubscribers.md) * [Get Subscriber](https://docs.recurly.com/recurly-commerce/reference/getsubscriber.md) * [Patch Subscriber](https://docs.recurly.com/recurly-commerce/reference/patchsubscriber.md) * [Get Subscriber Payment Methods](https://docs.recurly.com/recurly-commerce/reference/getsubscriberpaymentmethods.md) * [Post Subscriber Portal Token](https://docs.recurly.com/recurly-commerce/reference/postsubscriberportaltoken.md)