Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Subscriptions

Get Subscription

get/business/v2/subscriptions/{subscriptionId}

Path parameters

subscriptionIdstring required

The Subscription ID

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a Subscription.

idstring

The Subscription ID.

namestring

The name of the Subscription.

descriptionstring

A custom description of the Subscription.

platform'ADOBE' | 'AMAZON' | 'APPLE' | 'ATLASSIAN' | 'FACEBOOK' | 'FIGMA' | 'GITHUB' | 'GOOGLE' | 'HUBSPOT' | 'LINKEDIN' | 'MICROSOFT' | 'NOTION' | 'OTHER' | 'PINTEREST' | 'SALESFORCE' | 'TWITTER' | 'XERO' | 'ZOOM'
assigneesstring[]

List of User ID currently assigned to the Subscription and its Card.

status'ACTIVE' | 'ASSIGNED' | 'CANCELLED'
wallet_idstring

The ID of the Wallet the Subscription and its Card are linked to.

payment_frequency'OTHER' | 'YEARLY' | 'WEEKLY' | 'QUARTERLY' | 'MONTHLY'
last_spentnumber

The amount of the last Transaction made with the Card.

total_spentnumber

The overall amount spent with the Card.

card_idstring

The ID of the Card reserved for this Subscription (only available after the subscription is activated).

last_spent_datestring

The date and time of the last Transaction made with the Card.

creation_timestring

The date and time when the Subscription was last updated.

last_update_timestring

The date and time when the Subscription was last updated.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "EXAMPLE SUBSCRIPTION.",
  "description": "This is a subscription",
  "assignees": [
    "XMPL1234-000001",
    "XMPL1234-000002",
    "XMPL1234-000003"
  ],
  "wallet_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "last_spent": 75.01,
  "total_spent": 775.01,
  "card_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
  "last_spent_date": "2020-05-07T12:48:40Z",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z"
}