SMsmokeball
Subscriptions

Update subscription

Changed on

Updates a subscriptions tiers, add-ons, or interval.

Important considerations:

  • Updates cannot be made to canceled subscriptions
  • Billing will be prorated for the remaining period
  • Existing add-ons may need to be re-validated
  • Some features may be disabled if not available in new tier or add-ons
patch/subscriptions/{id}

Request

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

Path parameters

idstring required

The unique identifier of the subscription to update

Request body

tierIdstring uuid nullable

Optional tier id to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the supplied tier id.

archieTierIdstring uuid nullable

Optional Archie tier id to subscribe to. Omit or supply null to preserve the current Archie tier. Use DELETE /subscriptions/{id}/archie-tier to remove it.

addOnIdsstring[] nullable

Optional add-on ids to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the existing or supplied tier id.

intervalstring nullable

Optional billing interval/pricing option to use when setting subscription tier.

If an interval is not supplied then the default interval option will be used.

If an interval is supplied but a tier is not supplied, the existing tier is used and the interval is changed.

promotionIdstring uuid nullable

Optional promotion id to apply with the subscription change.

The promotion is validated against the requested tier, Archie tier, and add-ons.

reasonstring nullable

Optional reason for changing the subscription tier.

Example request

{
  "tierId": "8d074e85-4d95-4d9a-8a63-187719470d49",
  "interval": "Monthly",
  "promotionId": "8d074e85-4d95-4d9a-8a63-187719470d49"
}

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

  • 2fe552c5d11dRevision changes
    • info

      added the new optional request property //// (media type: application/json-patch+json)

    • info

      added the new optional request property //// (media type: application/json)

    • info

      added the new optional request property //// (media type: application/*+json)

  • 30062b3c3dd5Revision changes
    • info

      added the new optional request property //// (media type: application/json-patch+json)

    • info

      added the new optional request property //// (media type: application/json)

    • info

      added the new optional request property //// (media type: application/*+json)