SMsmokeball
Subscriptions

Get usage charges for a usage product

Returns a paged list of usage charges for a single usage product on the account's usage subscription, sorted by created date descending.

Supports the same filters as the subscription-wide charges endpoint, except the product filter: the usageId route parameter takes precedence over any ProductId supplied in the query.

get/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 list charges for

Query parameters

Fromstring date-time
Example:2022-04-01T00:00:00Z

Optional start date used to filter usage charges by created date.

Tostring date-time
Example:2022-04-30T23:59:59Z

Optional end date used to filter usage charges by created date.

Statusstring

Optional usage charge status filter.

Possible values: Pending, Succeeded, Failed, Canceled, Refunded.

MatterIdstring
Example:123456

Optional matter id used to filter usage charges.

UserIdstring
Example:3f44b470-5d39-41d0-a1ef-96e09e0eb5bb

Optional user id used to filter usage charges.

ProductIdstring
Example:6b07d1fc-a7ea-4da7-966f-eaa971f0e72c

Optional internal product id used to filter usage charges.

Offsetinteger
Limitinteger

Response

When request is successful. Returns a paged collection of 'Charge' objects.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "quantity": 1,
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z",
      "occurredDate": "2022-04-23T14:00:00Z"
    }
  ]
}

Changes

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