Skip to main content
GET
Fetch a subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription_id
integer
required

The ID of the subscription to fetch

Response

200 - application/json

OK

A subscription represents a recurring autoship order for a product, such as monthly flea medication delivery. Subscriptions are associated with a specific clinic, client, patient, and item, and define the frequency and quantity of each recurring order.

autoship_url_client
string
required

The client url for this subscription.

autoship_url_clinic
string
required

The clinic url for this subscription.

clinic_client_id
integer
required

The ID of the client this subscription belongs to.

clinic_id
integer
required

The ID of the clinic this subscription belongs to.

clinic_patient_id
integer
required

The ID of the patient for this subscription.

created
string<date-time>
required

The datetime this object was created.

frequency
integer
required

The number of interval units between subscription orders.

id
integer
required

The unique identifier for this subscription.

interval_unit
required

The unit of time between subscription orders.

Available options:
DAY,
WEEK,
MONTH,
YEAR
is_imported
boolean
required

Whether this subscription was imported from an external site.

item_id
integer
required

The ID of the item for this subscription.

last_order_date
string<date-time> | null
required

The date of the most recent order for this subscription.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

next_order_date
string<date-time>
required

The date of the next scheduled order for this subscription.

quantity
integer
required

The quantity of the item for this subscription.

status
enum<string>
required

The status of the subscription.

Available options:
ACTIVE,
CANCELED_VIA_CLINIC,
CANCELED_VIA_CLIENT,
CANCELED_DENIED,
CANCELED_VIA_ADMIN,
FAILED_PAYMENT,
PAUSED_VIA_CLIENT,
PAUSED_VIA_CLINIC,
PAUSED_BAD_ADDRESS,
PAUSED_PRESCRIPTION,
PAUSED_OUT_OF_STOCK,
PAUSED_MISSING_CLIENT_INFO,
PAUSED_FLAVOR_UNAVAILABLE,
PAUSED_OTHER,
IMPORTED
status_changed
string<date-time>
required

The time at which the subscription status was last changed.