VEvetcove
Subscriptions

Fetch a subscription

Fetches a subscription by its ID.

A subscription represents a recurring autoship order for a product (e.g., monthly flea and tick prevention). Each subscription is associated with a clinic, client, patient, and a specific catalog item, and defines the delivery frequency and quantity.

get/ext/v2/subscriptions/{subscription_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/subscriptions/{subscription_id}/
  • Auth
    HTTP bearer

Path parameters

subscription_idinteger required

The ID of the subscription to fetch

Response

OK

autoship_url_clientstring required

The client url for this subscription.

autoship_url_clinicstring required

The clinic url for this subscription.

clinic_client_idinteger required

The ID of the client this subscription belongs to.

clinic_idinteger required

The ID of the clinic this subscription belongs to.

clinic_patient_idinteger required

The ID of the patient for this subscription.

createdstring date-time required

The datetime this object was created.

frequencyinteger required

The number of interval units between subscription orders.

idinteger required

The unique identifier for this subscription.

is_importedboolean required

Whether this subscription was imported from an external site.

item_idinteger required

The ID of the item for this subscription.

last_order_datestring date-time nullable required

The date of the most recent order for this subscription.

modifiedstring date-time required

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

next_order_datestring date-time required

The date of the next scheduled order for this subscription.

quantityinteger required

The quantity of the item for this subscription.

status'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' required
status_changedstring date-time required

The time at which the subscription status was last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.