Sign in
Subscriptions

List related Subscriptions

Returns the other Subscriptions of the same Customer that were bought together with this one: those sharing its setup payment, plus — when the merchant has configured a grouping window — those created within that many minutes of it. Read-only; nothing is cancelled or changed.

get/subscriptions/{id}/related

Path parameters

idstring required

Response

OK

windowMinutesnumber required

The merchant's configured grouping window, in minutes, that this lookup applied. 0 means only the setup payment was used.

Example response

{
  "subscriptions": [
    {
      "id": "sub_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "status": "active",
      "cancelAtCycle": 2,
      "createdAtDeltaSeconds": 42,
      "currency": "usd",
      "priceName": "Monthly membership",
      "productName": "Membership",
      "matchedOn": "setup_payment"
    }
  ]
}

Changes

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