Skip to main content
GET
/
subscription
Get Subscription
curl --request GET \
  --url https://api.dontdie.com/subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dd-client-id: <api-key>'
{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "subscriptionId": "BLUEPRINT_BIOMARKERS",
  "status": "active",
  "paymentStatus": "paid",
  "currentPeriodStart": "2024-01-01T00:00:00Z",
  "currentPeriodEnd": "2024-02-01T00:00:00Z",
  "nextBillingDate": "2024-02-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "shopifyContractId": "gid://shopify/SubscriptionContract/1234567890",
  "shopifyCustomerId": "gid://shopify/Customer/1234567890"
}

Authorizations

​
Authorization
string
header
required

Enter your Bearer token in the format: Bearer

​
x-dd-client-id
string
header
required

Your API client ID for the request

Query Parameters

​
subscriptionId
string

The subscription ID to retrieve. If not provided, defaults to BLUEPRINT_BIOMARKERS for Blueprint clients, otherwise DONT_DIE_PREMIUM

Response

OK

​
userId
string

The ID of the user

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
subscriptionId
string

The subscription ID

Example:

"BLUEPRINT_BIOMARKERS"

​
status
enum<string>

The status of the subscription

Available options:
active,
cancelled,
expired,
incomplete,
past_due,
paused,
trialing,
unpaid
Example:

"active"

​
paymentStatus
enum<string>

The payment status of the subscription

Available options:
pending,
paid,
failed
Example:

"paid"

​
currentPeriodStart
string<date-time>

The start date of the current billing period

Example:

"2024-01-01T00:00:00Z"

​
currentPeriodEnd
string<date-time>

The end date of the current billing period

Example:

"2024-02-01T00:00:00Z"

​
nextBillingDate
string<date-time>

The next billing date

Example:

"2024-02-01T00:00:00Z"

​
createdAt
string<date-time>

The date the subscription was created

Example:

"2024-01-01T00:00:00Z"

​
updatedAt
string<date-time>

The date the subscription was last updated

Example:

"2024-01-01T00:00:00Z"

​
shopifyContractId
string | null

The Shopify contract ID (if applicable)

Example:

"gid://shopify/SubscriptionContract/1234567890"

​
shopifyCustomerId
string | null

The Shopify customer ID (if applicable)

Example:

"gid://shopify/Customer/1234567890"