v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscriptions

Get usage charge

Retrieves a single usage charge belonging to the account's usage subscription.

get/subscriptions/{subscriptionId}/charges/{id}

Path parameters

subscriptionIdstring required

The unique identifier of the usage subscription

idstring uuid required

The unique identifier of the usage charge

Response

When request is successful. Returns a 'Charge' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique identifier of the usage charge.

externalIdstring nullable

The external usage charge id.

externalAdjustmentIdstring nullable

The external adjustment id created when the usage charge is canceled.

expenseIdstring nullable

The Billing expense id created for the usage charge.

subscriptionIdstring nullable

The subscription id.

accountIdstring nullable

The Smokeball firm id.

userIdstring nullable

The user id that created the usage charge.

productIdstring nullable

The product id.

priceIdstring nullable

The internal price id.

metadataobject nullable

Caller-supplied metadata associated with the charge.

matterIdstring nullable

The matter id associated with the usage charge.

descriptionstring nullable

The description associated with the usage charge.

supplierTransactionIdstring nullable

The supplier transaction id associated with the usage charge.

supplierTransactionAmountnumber double nullable

The supplier transaction amount associated with the usage charge.

amountnumber double nullable

The total customer billing amount for the usage charge, in cents.

quantityinteger

The usage quantity recorded for the charge.

statusstring

The usage charge status.

Pending
Succeeded
Failed
Canceled
Refunded

failureReasonstring nullable

The reason the usage charge failed.

createdDatestring date-time

The created date of the usage charge.

updatedDatestring date-time

The updated date of the usage charge.

occurredDatestring date-time

The date the usage occurred.

Example response

{
  "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"
}