SMsmokeball
Subscriptions

Subscribe to usage product

Subscribes the account's usage subscription to a usage product. The subscription is processed asynchronously.

Important considerations:

  • If the account has no usage subscription yet, one is created as part of processing the request
  • A default payment method can optionally be supplied; it must already exist for the customer
  • Without one, a payment method added for the usage subscription before it existed is used
post/subscriptions/{subscriptionId}/usages/{id}

Request

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

Path parameters

subscriptionIdstring required

The unique identifier of the usage subscription

idstring uuid required

The unique identifier of the usage product to subscribe to

Request body

defaultPaymentMethodIdstring uuid nullable

Public id of the payment method to set as the default for the usage subscription.

Response

When request is accepted. Returns a 'Link' object to the subscription.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.