Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Subscriptions

Get Subscription

Get a single subscription by its ID. Results are limited to only show subscriptions authorized by the X-API-Key and X-Publishable-Key.

get/v1/subscriptions/{subscription_id}

Path parameters

subscription_idstring required

The unique ID for a Bolt subscription.

Example:sub_1a2b3c4d5e

The unique ID for the subscription.

Headers

X-Publishable-Keystring required

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard.

Response

Success

idstring required

The unique ID for a Bolt subscription.

created_atstring date-time required
updated_atstring date-time required
merchant_namestring required

The name of the merchant this subscription belongs to.

emailstring nullable required

The email address of the shopper who owns this subscription. Nullable.

next_renewal_datestring date-time nullable

The date of the next scheduled renewal, if any.

next_payment_retry_datestring date-time nullable

The date of the next scheduled payment retry, if the subscription currently has a failed payment.

canceled_datestring date-time nullable
paused_datestring date-time nullable
product_namesstring[] required
metadataobject required

Merchant-defined custom metadata.

Example response

{
  "id": "sub_1a2b3c4d5e",
  "merchant_name": "Bolt Swag Store",
  "email": "shopper@example.com",
  "status_details": {
    "type": "active",
    "reason": "payment_failed"
  },
  "payment_method": {
    "card_last_4": "4242",
    "card_network": "visa"
  },
  "plan": {
    "id": "plan_9f8e7d6c5b",
    "name": "Monthly",
    "sku": "SUB-MONTHLY-001",
    "frequency": 1,
    "frequency_unit": "month",
    "product_id": "prod_3c2b1a0f9e",
    "checkout_link": "https://subscribe.boltapp.com/plans/plan_9f8e7d6c5b",
    "initial_period": {
      "frequency": 14,
      "frequency_unit": "day"
    }
  },
  "total_amount": {
    "amount": 754,
    "currency": "USD",
    "currency_symbol": "$"
  }
}