SMsmokeball
Subscriptions

Get all available Archie tiers

Changed on
get/subscriptions/archie-tiers

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/archie-tiers
  • Auth
    API key in header x-api-key and API key in header Authorization

Response

OK

idstring uuid

Unique identifier of the tier.

hrefstring nullable
relationstring nullable
methodstring nullable
smokeballIdstring nullable

Unique Smokeball identifier of the tier.

This identifier convenience purposes only and should not be used to interact with the subscriptions API.

productSuitestring nullable

The product suite that this tier belongs to.

namestring nullable

The display name of the tier.

descriptionstring nullable

The description of the tier.

Can be used to describe the tier to a customer.

trialPeriodDaysinteger nullable

The number of days the tier can be trialed for.

Cannot be trialed if zero or missing.

createdDatestring date-time

The created date of the tier.

updatedDatestring date-time

The updated date of the tier.

Example response

[
  {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "name": "Intake",
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  }
]

Changes