SMsmokeball
Subscriptions

Create usage charge

Changed on

Creates a one-off charge (quantity 1) against a usage product the account is subscribed to. The charge is processed asynchronously.

Important considerations:

  • The usage product must already be subscribed on the account's usage subscription
  • The price must exist on the usage product and be active
  • Charges are rejected while the usage subscription is overdue (past due, unpaid, canceled, or incomplete-expired)
  • The caller must be authorized for usage billing on the product
post/subscriptions/{subscriptionId}/usages/{usageId}/charges

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/{subscriptionId}/usages/{usageId}/charges
  • 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

usageIdstring uuid required

The unique identifier of the usage product to charge

Request body

priceIdstring uuid nullable

The price to charge for this usage product.

matterIdstring uuid nullable

The matter id associated with the usage charge.

descriptionstring nullable

The description associated with the usage charge.

metadataobject nullable

Optional metadata associated with the usage charge.

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

  • 2fe552c5d11dRevision changes
    • info

      added the non-success response with the status

  • 197984da9b42Revision changes
    • info

      the request property //// became nullable (media type: application/json-patch+json)

    • info

      the request property //// became nullable (media type: application/json)

    • info

      the request property //// became nullable (media type: application/*+json)

    • info

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

    • info

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

    • info

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