Skip to main content
POST
Create a patient subscription

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Body

application/json
patient_id
string<uuid>
required
item_kind
enum<string>
required
Available options:
product,
custom,
bundle
item_id
string<uuid>
required
cadence
enum<string>
required
Available options:
weekly,
monthly,
quarterly
payment_method_id
string<uuid>
required
quantity
integer
default:1
Required range: 1 <= x <= 99
ship_to_address_id
string<uuid> | null

Response

Subscription created.