Skip to content

Get subscription by ID

Request

Retrieve a single subscription for the location, including line items.

Security
PartnerApiKey and PartnerOAuth
Path
subscriptionIdinteger, (int64)required

Subscription ID

Example:1234
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/subscription/1234' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Subscription retrieved successfully

Bodyapplication/json
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
endDatestring, (date-time)

Subscription end date (UTC midnight of stored date)

Example:"2025-01-15T14:00:00Z"
externalIdstring

External identifier from the processor or integrator

Example:"ext_sub_001"
idinteger, (int64)

Subscription ID

Example:1234
lineItemsArray of objects(SubscriptionLineItemDTO)

Line items on the subscription

locationIdinteger, (int64)

Location ID

Example:200
nextBillingDatestring, (date-time)

Next billing date (UTC midnight of stored date)

Example:"2025-01-15T14:00:00Z"
notestring

Internal note

Example:"Patient approved monthly plan"
occurrencesinteger, (int32)

Total billing occurrences when limited

Example:12
orderIdinteger, (int64)

Purchase order ID when tied through an order subscription

Example:700
patientIdinteger, (int64)

Patient ID (account patient)

Example:300
paymentCustomerIdinteger, (int64)

Payment customer ID. May be null for legacy subscriptions without a resolved payment customer.

Example:400
paymentMethodIdinteger, (int64)

Payment method ID when set

Example:500
recurrenceFrequencyUnitstring

Recurrence interval unit

Example:"MONTHLY"
recurrenceFrequencyValueinteger, (int32)

Recurrence interval count

Example:1
startDatestring, (date-time)

Subscription start date (UTC midnight of stored date)

Example:"2025-01-15T14:00:00Z"
statusstring

Subscription status

Enum:"DRAFT""ACTIVE""PENDING""PAUSED""CANCELLED""COMPLETED""FAILED""VOID"
Example:"ACTIVE"
updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "createdAt": "2025-01-15T14:00:00Z",
  "endDate": "2025-01-15T14:00:00Z",
  "externalId": "ext_sub_001",
  "id": 1234,
  "lineItems": [
    { … }
  ],
  "locationId": 200,
  "nextBillingDate": "2025-01-15T14:00:00Z",
  "note": "Patient approved monthly plan",
  "occurrences": 12,
  "orderId": 700,
  "patientId": 300,
  "paymentCustomerId": 400,
  "paymentMethodId": 500,
  "recurrenceFrequencyUnit": "MONTHLY",
  "recurrenceFrequencyValue": 1,
  "startDate": "2025-01-15T14:00:00Z",
  "status": "ACTIVE",
  "updatedAt": "2025-01-15T14:00:00Z"
}